iwpnd / fastapi-key-auth

FastAPI API key authorizer

Hi 👋, I'm Ben

I'm a backend software engineer with a background in geographic sciences, a strong focus on geospatial solutions and a heart for open-source.

• 🗺 I'm open for new challenges.
• 🛴 I'm a Backend Software Developer at TIER|Dott with the geo team.
• 🚙 I was a Data Engineer and Software Developer at HERE with Local Data Intelligence.

fastapi-key-auth's Issues

Error when installing with FastAPI 0.71 & Starlette 0.17.1

Descroption:
When using pip to install the current version of FastAPI-Key-Auth install fails with the following error message:

ERROR: fastapi-key-auth 0.7.0 has requirement fastapi<0.71.0,>=0.70.0, but you'll have fastapi 0.71.0 which is incompatible.
ERROR: fastapi-key-auth 0.7.0 has requirement starlette<0.17.0,>=0.16.0, but you'll have starlette 0.17.1 which is incompatible.

suggested Fix
Update dependency to allow for newer version

Where do I put the API KEY ?

Where in the project do i put the correct API KEY?

http post http://localhost:8001/vehicle x-api-key:test

Where in the project do i put 'test'?

➜  ~ echo '{ "data": { "type": "Feature", "geometry": {"type": "Point", "coordinates": [13.37, 52.25]}, "properties": {"id": "truck"}}}' \
      | http post http://localhost:8000/vehicle x-api-key:test
HTTP/1.1 401 Unauthorized
content-length: 25
content-type: application/json
date: Mon, 27 Jun 2022 00:55:07 GMT
server: uvicorn

{
    "detail": "unauthorized"
}

I dont know how to get the header validated, where do i put the word 'test'?

Cannot install with recent FastAPI

I'm currently getting an issue with installing with the lastest FastAPI. This looks to be very similar to #60

I see that Dependabot has already updated the dependencies. Any chance you could roll a new release? TIA.

ERROR: Cannot install -r requirements.txt (line 4) and fastapi==0.75.2 because these package versions have conflicting dependencies.

The conflict is caused by:
    The user requested fastapi==0.75.2
    fastapi-key-auth 0.7.1 depends on fastapi<0.72.0 and >=0.71.0

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

Doesn't install with recent FastAPI

Another FastAPI release means the starlette dependency is incompatible again:

#0 45.50 ERROR: Cannot install -r requirements.txt (line 3) and -r requirements.txt (line 4) because these package versions have conflicting dependencies.
#0 45.50 
#0 45.50 The conflict is caused by:
#0 45.50     fastapi 0.95.0 depends on starlette<0.27.0 and >=0.26.1
#0 45.50     fastapi-key-auth 0.10.1 depends on starlette<0.26.0 and >=0.25.0

key_pattern value is being checked for each iteration

key_pattern can be checked once before the loop and then assigned and reused