diff options
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -1,5 +1,7 @@ # VPNAuth +OAuth2/OIDC Server recognizing users based on their IP. + ## The idea The idea of VPNAuth is that you only need to log into your VPN and from then you get automatically logged into your apps @@ -44,4 +46,15 @@ Here is an example ``config.json`` with explanations: (Remember that this config is invalid as the JSON standard does not allow comments.) +## Endpoints + +| Uri | Protocol | Description | Response status codes and their meaning | +|-------------------|----------|----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ``/auth`` | OAuth | Autorization request - initializes the authorization process | / | +| ``/access-token`` | OAuth | Endpoint where client requests the access token with the issued code in PKCE challenge | - ``400``: The form does not require required parameters<br/>- ``403``: client secret or code challenge is wrong<br/> - ``404``: invalid auth code | +| ``/user-info`` | OIDC | Endpoint where the client requests information about the user | - ``405``: Request method is not ``GET`` or ``POST``<br/> - ``400``/``401``: invalid authorization header<br/> - ``403``: invalid token or not all required scopes<br/> - ``204``: User has not set any user information yet | + You find out how to reach me [here](https://bytim.eu/contact) if you have any questions or feedback. + +**The [OAuth2](https://datatracker.ietf.org/doc/html/rfc6749), [PKCE](https://datatracker.ietf.org/doc/html/rfc7636) +and [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) Protocols are not fully implemented!** |