API key authentication concept in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is API key authentication?

API key authentication is a simple way to control access to an API by requiring a unique key from the client with each request. The server checks this key to allow or deny access.

beginner

How is an API key usually sent in a Flask request?

An API key is commonly sent in the request header, often in the 'Authorization' header or a custom header like 'x-api-key'.

beginner

Why should API keys be kept secret?

API keys grant access to protected resources. If someone else gets your key, they can use your API privileges, which can lead to misuse or data leaks.

intermediate

What is a simple way to check an API key in a Flask route?

You can check the API key by reading it from the request headers and comparing it to a stored valid key before processing the request.

intermediate

What is one limitation of API key authentication?

API key authentication does not verify the identity of the user, only that the key is valid. It also does not encrypt the key, so it should be used with HTTPS.

Where is the API key typically sent in a Flask API request?

A In the URL path

B In the request headers

C In the response body

D In the server logs

API keys are usually sent in the request headers to keep them secure and separate from the URL.

What should a Flask app do if the API key is missing or invalid?

A Process the request normally

B Redirect to another page

C Ignore the key and log a warning

D Return an error response like 401 Unauthorized

The app should reject requests without a valid API key by returning a 401 Unauthorized status.

Why is HTTPS important when using API key authentication?

A It encrypts the API key during transmission

B It speeds up the API response

C It hides the API key in the URL

D It automatically validates the API key

HTTPS encrypts data sent between client and server, protecting the API key from being intercepted.

Which Flask object is used to access request headers?

A flask.request

B flask.Request

C flask.Response

D flask.session

The 'flask.request' object provides access to incoming request data including headers.

What is a common header name used to send an API key?

A Content-Type

B User-Agent

C Authorization

D Accept

The 'Authorization' header is commonly used to send API keys or tokens.

Explain how API key authentication works in a Flask application.

Think about the steps from client request to server response.

Describe best practices for securing API keys in Flask APIs.

Consider how to protect keys from being stolen or misused.

Practice

1. What is the main purpose of using an API key in Flask applications?

easy

A. To style the API output

B. To verify that the client is authorized to access the API

C. To speed up the API response time

D. To store user passwords securely

Solution

1. Step 1: Understand API key role

   An API key is a secret token sent by the client to prove identity.

2. Step 2: Identify purpose in Flask

   The server checks this key to allow or deny access to API resources.

3. Final Answer:

   To verify that the client is authorized to access the API -> Option B

4. Quick Check:

   API key = Authorization [OK]

Hint: API keys prove client identity to server [OK]

Common Mistakes:

• Thinking API keys speed up responses
• Confusing API keys with styling tools
• Using API keys to store passwords

2. Which of the following is the correct way to retrieve an API key from request headers in Flask?

easy

A. api_key = request.cookies.get('X-API-KEY')

B. api_key = request.args['X-API-KEY']

C. api_key = request.form['X-API-KEY']

D. api_key = request.headers.get('X-API-KEY')

Solution

1. Step 1: Identify where API keys are usually sent

   API keys are commonly sent in HTTP headers for security.

2. Step 2: Use Flask syntax to get header value

   Use request.headers.get('Header-Name') to safely retrieve header values.

3. Final Answer:

   api_key = request.headers.get('X-API-KEY') -> Option D

4. Quick Check:

   Headers use request.headers.get() [OK]

Hint: Use request.headers.get() for header values [OK]

Common Mistakes:

• Using request.args for headers
• Trying to get API key from form data
• Looking for API key in cookies

3. Given this Flask code snippet, what will be the response if the client sends a request with header X-API-KEY: wrongkey?

from flask import Flask, request, jsonify
app = Flask(__name__)

VALID_API_KEY = 'secret123'

@app.route('/data')
def data():
    api_key = request.headers.get('X-API-KEY')
    if api_key == VALID_API_KEY:
        return jsonify({'message': 'Access granted'})
    else:
        return jsonify({'error': 'Unauthorized'}), 401

medium

A. {"error": "Unauthorized"}

B. {"message": "Access granted"}

C. 500 Internal Server Error

D. Empty response with status 200

Solution

1. Step 1: Check API key comparison

   The code compares the header key to 'secret123'. 'wrongkey' does not match.

2. Step 2: Determine response for wrong key

   Since keys differ, the else block returns a JSON error with status 401.

3. Final Answer:

   {"error": "Unauthorized"} -> Option A

4. Quick Check:

   Wrong key = Unauthorized error [OK]

Hint: Wrong key triggers 401 Unauthorized JSON error [OK]

Common Mistakes:

• Assuming any key grants access
• Expecting 500 error for wrong key
• Thinking response is empty

4. Identify the error in this Flask API key check code:

from flask import Flask, request
app = Flask(__name__)

VALID_KEY = 'abc123'

@app.route('/info')
def info():
    api_key = request.headers['X-API-KEY']
    if api_key = VALID_KEY:
        return 'Access allowed'
    else:
        return 'Access denied', 403

medium

A. Using single equals (=) instead of double equals (==) in if condition

B. Accessing headers with request.headers.get() instead of []

C. Missing return type for response

D. Route decorator syntax is incorrect

Solution

1. Step 1: Check if condition syntax

   The if statement uses '=' which is assignment, not comparison.

2. Step 2: Correct comparison operator

   Use '==' to compare api_key and VALID_KEY for equality check.

3. Final Answer:

   Using single equals (=) instead of double equals (==) in if condition -> Option A

4. Quick Check:

   Comparison needs '==' not '=' [OK]

Hint: Use '==' for comparison, '=' is assignment [OK]

Common Mistakes:

• Confusing '=' with '==' in conditions
• Thinking request.headers['X-API-KEY'] is wrong
• Believing return type must be explicit

5. You want to protect multiple Flask routes using the same API key check without repeating code. Which approach is best to implement this efficiently?

hard

A. Copy the API key check code inside every route function

B. Check the API key only in the first route and assume others are safe

C. Create a decorator function that checks the API key before running the route function

D. Use a global variable to store the API key and skip checks

Solution

1. Step 1: Understand code reuse for API key checks

   Repeating code in every route is inefficient and error-prone.

2. Step 2: Use a decorator to wrap routes

   A decorator can run the API key check before the route logic, applying it to many routes cleanly.

3. Final Answer:

   Create a decorator function that checks the API key before running the route function -> Option C

4. Quick Check:

   Decorator = reusable API key check [OK]

Hint: Use decorators to avoid repeating API key checks [OK]

Common Mistakes:

• Copy-pasting code in every route
• Skipping checks on some routes
• Using global variables to bypass security