https://github.com/postgrest-oauth/api
oAuth2 server for begriffs/postgrest
https://github.com/postgrest-oauth/api
Last synced: 5 months ago
JSON representation
oAuth2 server for begriffs/postgrest
- Host: GitHub
- URL: https://github.com/postgrest-oauth/api
- Owner: postgrest-oauth
- License: mit
- Created: 2017-11-06T19:25:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-21T15:35:54.000Z (over 4 years ago)
- Last Synced: 2024-08-03T22:19:28.380Z (8 months ago)
- Language: Go
- Size: 254 KB
- Stars: 28
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - postgrest-oauth/api - oAuth2 server for begriffs/postgrest (Go)
README
README
------
[](https://travis-ci.org/postgrest-oauth/api)
Environment Variables
=====================
**OAUTH_DB_CONN_STRING**
Default: "postgres://user:pass@postgresql:5432/test?sslmode=disable"
See http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING for more information about connection string parameters.
**OAUTH_ACCESS_TOKEN_JaW_SECRET**
Default: "morethan32symbolssecretkey!!!!!!"
Random string. Should be >= to 32 symbols. This is important.
**OAUTH_ACCESS_TOKEN_TTL=7200**
Default: 7200
Access token life cycle in seconds
**OAUTH_REFRESH_TOKEN_SECRET**
Default: "notlesshan32symbolssecretkey!!!!"
Random string. Should be >= to 32 symbols. This is important.
**OAUTH_COOKIE_HASH_KEY**
Default: "supersecret"
Random string.
**OAUTH_COOKIE_BLOCK_KEY**
Default: "16charssecret!!!"
Random string. Should be equal to 16, 24 or 32 symbols. This is important.
**OAUTH_VALIDATE_REDIRECT_URI**
Default: true
This setting should be `true` when you use this in production. When set to `false` you can use any **redirect_uri**. Handy for development.
**OAUTH_CODE_UI**
Default: http://localhost:3685
This is a URL of UI that is used for Authorization Code Flow.
**OAUTH_CORS_ALLOW_ORIGIN**
Default: http://localhost:3685,http://localhost:3001
Allowed CORS origins
**HASURA_ALLOWED_ROLES**
Example: "editor,user"
If specified, support for Hasura will be enabled and Hasura specific info will be added to the token:
```
"https://hasura.io/jwt/claims": {
"x-hasura-allowed-roles": ["editor","user"],
"x-hasura-default-role": "user",
"x-hasura-user-id": "123"
}
```
More info: https://hasura.io/docs/1.0/graphql/manual/auth/authentication/jwt.html
Facebook Signup/Signin
======================
Prepare
-------
1. Go to [developers.facebook.com](https://developers.facebook.com) and create an app, add Facebook Login product ([tutorial](https://youtu.be/MpLCBEdhg3Y))
2. Add OAUTH_FACEBOOK_CLIENT_ID and OAUTH_FACEBOOK_CLIENT_SECRET environmental variables
Configure your app
---------------
Add 2 functions to your database
```SQL
CREATE OR REPLACE FUNCTION oauth2.create_facebook_owner(obj json, phone varchar, OUT id varchar, OUT role varchar, OUT jti varchar)
AS $$
INSERT INTO api.users(email, phone, role, facebook_id)
VALUES
(
obj->>'email'::varchar,
phone,
'verified',
obj->>'id'::varchar
)
RETURNING id::varchar, role::varchar, jti::varchar;
$$ LANGUAGE SQL;
CREATE OR REPLACE FUNCTION oauth2.check_owner_facebook(facebook_id varchar, OUT id varchar, OUT role varchar, OUT jti varchar)
AS $$
SELECT id::varchar, role::varchar, jti::varchar FROM api.users
WHERE facebook_id = check_owner_facebook.facebook_id;
$$ LANGUAGE SQL;
```
Get facebook button URL
```
GET http://localhost:3684/facebook/url?redirect_uri=http://localhost:3685/
```
After user clicks it he'll be returned to your app with `code` and `state`. Pass them to `/api/enter` route
```
POST http://localhost:3684/facebook/enter
Content-Type: application/x-www-form-urlencoded
code={CODE}&state={STATE}
```
If user don't exist it will be created. If it exists he'll be signed in. Now you can redirect your app to `/authorize`
Testing with Newman
===================
```
$ cd ./example
$ docker-compose -f docker-compose.yml up -d --build
$ cd ../
$ newman run --bail --ignore-redirects --global-var host=localhost ./postgrest-oauth-server.postman_collection.json
```