Updates

Author: eliasjpr

Dockerfile

@@ -4,11 +4,13 @@ WORKDIR /opt/app
 COPY . /opt/app
 RUN shards install
 RUN crystal build --release --static ./src/server.cr -o ./server
+RUN crystal build --release --static ./taskfile.cr -o ./azu
 CMD ["crystal", "spec"]
 
 FROM alpine:latest  
 RUN apk --no-cache add ca-certificates
 WORKDIR /root/
 COPY --from=0 /opt/app/server .
+COPY --from=0 /opt/app/azu .
 COPY --from=0 /opt/app/public ./public
 CMD ["./server"]

README.md

@@ -1,6 +1,6 @@
-<div style="text-align:center"><img src="https://raw.githubusercontent.com/azutoolkit/authority/main/logo.png" /></div>
+<div style="text-align:center"><img src="https://github.com/azutoolkit/authority/blob/main/logo.png"></div>
 
-# authority
+# Authority
 
 OpenID Connect and OAuth Provider written in Crystal - Security-first, open
 source API security for your infrastructure. SDKs to come.
@@ -13,70 +13,104 @@ Implementing and using OAuth2 without understanding the whole specification is
 challenging and prone to errors, even when SDKs are being used. The primary goal
 of Authority is to make OAuth 2.0 and OpenID Connect 1.0 better accessible.
 
-## Installation
+The specification describes five grants for acquiring an access token:
 
-TODO: Write installation instructions here
+- Authorization code grant
+- Implicit grant
+- Resource owner credentials grant
+- Client credentials grant
+- Refresh token grant
 
-## Usage
+## JSON Web Tokens
 
-TODO: Write usage instructions here
+At this moment Authority issues JWT OAuth 2.0 Access Tokens as default.
 
-## Features Missing
+## Features
 
-Token Information Endpoint
+Grant Types
 
-```bash
-POST /token_info HTTP/1.1
-Host: authorization-server.com
-Authorization: Basic Y4NmE4MzFhZGFkNzU2YWRhN
+- [x] Authorization code grant
+- [x] Implicit grant
+- [x] Resource owner credentials grant
+- [x] Client credentials grant
+- [x] Refresh token grant
+- [x] OpenID Connect
+- [x] PKCE
+- [ ] Token Introspection
+- [ ] Token Revocation
 
-token=c1MGYwNDJiYmYxNDFkZjVkOGI0MSAgLQ
-```
+## Configuration
 
-```bash
-HTTP/1.1 200 OK
-Content-Type: application/json; charset=utf-8
-
-{
-  "active": true,
-  "scope": "read write email",
-  "client_id": "J8NFmU4tJVgDxKaJFmXTWvaHO",
-  "username": "aaronpk",
-  "exp": 1437275311
-}
+Configuration files can be found in `./src/config`
+
+### Authly.cr
+
+This file contains the configuration for the OAuthly 2 library. Read more about [Authly shards](https://github.com/azutoolkit/authly)
+
+```crystal
+# Configure
+Authly.configure do |c|
+  # Secret Key for JWT Tokens
+  c.secret_key = "ExampleSecretKey"
+
+  # Refresh Token Time To Live
+  c.refresh_ttl = 1.hour
+
+  # Authorization Code Time To Live
+  c.code_ttl = 1.hour
+
+  # Access Token Time To Live
+  c.access_ttl = 1.hour
+
+  # Using your own classes
+  c.owners = Authority::OwnerService.new
+  c.clients = Authority::ClientService.new
+end
 ```
 
-ID Tokens
+### Clear.cr
+
+This file contains the database configuration. No changes to this files is required.
+
+### Local.env
+
+This file contains the environment variables for Authority.
 
 ```bash
-{
-  "iss": "https://server.example.com",
-  "sub": "24400320",
-  "aud": "s6BhdRkqt3",
-  "nonce": "n-0S6_WzA2Mj",
-  "exp": 1311281970,
-  "iat": 1311280970,
-  "auth_time": 1311280969,
-  "acr": "urn:mace:incommon:iap:silver"
-}
+CRYSTAL_ENV=development
+CRYSTAL_LOG_SOURCES="*"
+CRYSTAL_LOG_LEVEL="debug"
+CRYSTAL_WORKERS=4
+PORT=4000
+PORT_REUSE=true
+HOST=0.0.0.0
+DATABASE_URL=postgres://auth_user:auth_pass@db:5432/authority_db
 ```
 
-User Registration
+## HTML Templates
+
+You can change the look of Authority `signin` and `authorize` html pages.
 
-Client Registration
+Just edit the `./public/templates/signin.html` and `./public/templates/authorize.html`
 
-## Development
+## Installation
+
+### Docker Compose
+
+Spin up your server
 
-TODO: Write development instructions here
+```bash
+docker-compose up server
+```
 
 ## Contributing
 
-1. Fork it (<https://github.com/your-github-user/authority/fork>)
+1. Fork it (https://github.com/azutoolkit/authority/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
 ## Contributors
 
-- [Elias Perez](https://github.com/your-github-user) - creator and maintainer
+- [Elias Perez](https://github.com/eliasjpr) - creator and maintainer

docker-compose.yml

@@ -10,16 +10,29 @@ services:
     ports:
       - 5432:5432
 
+  migrator:
+    build:
+      context: .
+      dockerfile: migrate.Dockerfile
+    container_name: migrator
+    working_dir: /root/
+    env_file:
+      - local.env
+    ports:
+      - "4000:4000"
+    depends_on:
+      - db
+
   server:
     build:
       context: .
       dockerfile: Dockerfile
     command: ./server
-    container_name: web
+    container_name: authority
     working_dir: /root/
     env_file:
       - local.env
     ports:
       - "4000:4000"
     depends_on:
-      - db
+      - migrator

local.env

@@ -5,4 +5,4 @@ CRYSTAL_WORKERS=4
 PORT=4000
 PORT_REUSE=true
 HOST=0.0.0.0
-DATABASE_URL=postgres://auth_user:auth_pass@localhost:5432/authority_db
+DATABASE_URL=postgres://auth_user:auth_pass@db:5432/authority_db

migrate.Dockerfile

@@ -0,0 +1,7 @@
+
+FROM crystallang/crystal:latest-alpine
+WORKDIR /opt/app
+COPY . /opt/app
+RUN shards install
+RUN crystal build --release --static ./taskfile.cr -o ./azu
+CMD ["./azu", "db", "migrate"]

src/server.cr

@@ -1,4 +1,5 @@
 require "./authority"
+
 # Start your server
 # Add Handlers to your App Server
 Authority.start [