Merge pull request #1 from code-specialist/oauth2autobackend

OAuth2Middleware with automatic renewal added

Author: yannicschroeer

.gitignore

@@ -6,6 +6,9 @@ __pycache__/
 # C extensions
 *.so
 
+# Docs
+docs/site/**
+
 # IDEs
 .DS_Store
 .idea

docs/docs/api-reference/oauth2.md

@@ -0,0 +1,5 @@
+# OAuth2Middleware
+::: fastapi_auth_middleware.OAuth2Middleware
+
+## OAuth2Backend
+::: fastapi_auth_middleware.oauth2_middleware.OAuth2Backend

docs/docs/examples/oauth2.md

@@ -0,0 +1,28 @@
+# OAuth2
+
+```python
+import uvicorn
+from fastapi import FastAPI
+from starlette.requests import Request
+
+from fastapi_auth_middleware import OAuth2Middleware
+
+
+def get_public_key():
+    with open("key.pem") as keyfile:
+        return keyfile.readlines()
+
+
+app = FastAPI()
+# Add the middleware with a public key for your JWT signer
+app.add_middleware(OAuth2Middleware, public_key=get_public_key())
+
+
+@app.get('/')  # Sample endpoint (secured)
+def home(request: Request):
+    return request.user  # Returns the user object that is injected into the request. The FastAPIUser in this case
+
+
+if __name__ == '__main__':
+    uvicorn.run('oauth2:app', host="0.0.0.0", port=8080)  # Starts the uvicorn ASGI
+```

docs/docs/examples/oauth2_automatic_renewal.md

@@ -0,0 +1,33 @@
+# OAuth2 Automatic Renewal
+
+```python
+import uvicorn
+from fastapi import FastAPI
+from starlette.requests import Request
+
+from fastapi_auth_middleware import OAuth2Middleware
+
+
+def get_new_token(old_token: str):
+    # TODO: implement this logic
+    return "eyJgh..."
+
+
+def get_public_key():
+    with open("key.pem") as keyfile:
+        return keyfile.readlines()
+
+
+app = FastAPI()
+# Add the middleware with the function that will return a new token and a public key for your JWT signer
+app.add_middleware(OAuth2Middleware, get_new_token=get_new_token, public_key=get_public_key())
+
+
+@app.get('/')  # Sample endpoint (secured)
+def home(request: Request):
+    return request.user  # Returns the user object that is injected into the request. The FastAPIUser in this case
+
+
+if __name__ == '__main__':
+    uvicorn.run('oauth2_automatic_renewal:app', host="0.0.0.0", port=8080)  # Starts the uvicorn ASGI
+```

docs/mkdocs.yml

@@ -33,13 +33,16 @@ theme:
 nav:
   - Introduction: ./index.md
   - Examples:
-    - Basic: ./examples/index.md
-    - Basic with Scopes: ./examples/simple_with_scopes.md
-    - Protected and Unprotected endpoints: ./examples/multiple.md
+      - Basic: ./examples/index.md
+      - Basic with Scopes: ./examples/simple_with_scopes.md
+      - Protected and Unprotected endpoints: ./examples/multiple.md
+      - OAuth2: ./examples/oauth2.md
+      - OAuth2, auto token renewal: ./examples/oauth2_automatic_renewal.md
   - API Reference:
-    - Middleware: ./api-reference/auth-middleware.md
-    - Backend: ./api-reference/auth-backend.md
-    - User: ./api-reference/user.md
+      - Middleware: ./api-reference/auth-middleware.md
+      - Backend: ./api-reference/auth-backend.md
+      - User: ./api-reference/user.md
+      - OAuth2: ./api-reference/oauth2.md
 
 markdown_extensions:
   - pymdownx.highlight
@@ -55,8 +58,8 @@ markdown_extensions:
   - pymdownx.snippets
 
 plugins:
-- search
-- mkdocstrings
+  - search
+  - mkdocstrings
 
 extra_css:
   - ./css/styles.css