https://github.com/perfectlysoft/perfect-turnstile-mongodb
A MongoDB ORM single-package integration for Turnstile authentication.
https://github.com/perfectlysoft/perfect-turnstile-mongodb
authentication mongodb perfect server-side-swift swift turnstile turnstile-authentication
Last synced: 26 days ago
JSON representation
A MongoDB ORM single-package integration for Turnstile authentication.
- Host: GitHub
- URL: https://github.com/perfectlysoft/perfect-turnstile-mongodb
- Owner: PerfectlySoft
- License: apache-2.0
- Created: 2017-01-16T05:33:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-04T21:59:15.000Z (over 7 years ago)
- Last Synced: 2025-04-08T18:51:22.992Z (about 2 months ago)
- Topics: authentication, mongodb, perfect, server-side-swift, swift, turnstile, turnstile-authentication
- Language: Swift
- Homepage: https://github.com/PerfectExamples/Perfect-Turnstile-MongoDB-Demo
- Size: 20.5 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Perfect Turnstile with MongoDB [简体中文](README.zh_CN.md)
This project integrates Stormpath's Turnstile authentication system into a single package with Perfect, and a MongoDB ORM.
## Installation
In your Package.swift file, include the following line inside the dependancy array:
``` swift
.Package(
url: "https://github.com/PerfectlySoft/Perfect-Turnstile-MongoDB.git",
majorVersion: 1
)
```
## Included JSON Routes
The framework includes certain basic routes:
```
POST /api/v1/login (with username & password form elements)
POST /api/v1/register (with username & password form elements)
GET /api/v1/logout
```
## Included Routes for Browser
The following routes are available for browser testing:
```
http://localhost:8181
http://localhost:8181/login
http://localhost:8181/register
```
These routes are using Mustache files in the webroot directory.
Example Mustache files can be found in [https://github.com/PerfectExamples/Perfect-Turnstile-PostgreSQL-Demo](https://github.com/PerfectExamples/Perfect-Turnstile-PostgreSQL-Demo)
## Creating an HTTP Server with Authentication
``` swift
import PerfectLib
import PerfectHTTP
import PerfectHTTPServer
import StORM
import MongoDBStORM
import PerfectTurnstileMongoDB
// Used later in script for the Realm and how the user authenticates.
let pturnstile = TurnstilePerfectRealm()
// Set the connection
MongoDBConnection.host = "localhost"
MongoDBConnection.database = "perfect_testing"
// Connect the AccessTokenStore
tokenStore = AccessTokenStore(connect!)
// Create HTTP server.
let server = HTTPServer()
// Register routes and handlers
let authWebRoutes = makeWebAuthRoutes()
let authJSONRoutes = makeJSONAuthRoutes("/api/v1")
// Add the routes to the server.
server.addRoutes(authWebRoutes)
server.addRoutes(authJSONRoutes)
// Add more routes here
var routes = Routes()
// routes.add(method: .get, uri: "/api/v1/test", handler: AuthHandlersJSON.testHandler)
// Add the routes to the server.
server.addRoutes(routes)
// add routes to be checked for auth
var authenticationConfig = AuthenticationConfig()
authenticationConfig.include("/api/v1/check")
authenticationConfig.exclude("/api/v1/login")
authenticationConfig.exclude("/api/v1/register")
let authFilter = AuthFilter(authenticationConfig)
// Note that order matters when the filters are of the same priority level
server.setRequestFilters([pturnstile.requestFilter])
server.setResponseFilters([pturnstile.responseFilter])
server.setRequestFilters([(authFilter, .high)])
// Set a listen port of 8181
server.serverPort = 8181
// Where to serve static files from
server.documentRoot = "./webroot"
do {
// Launch the HTTP server.
try server.start()
} catch PerfectError.networkError(let err, let msg) {
print("Network error thrown: \(err) \(msg)")
}
```
### Requirements
Define the "Realm" - this is the Turnstile definition of how the authentication is handled. The implementation is specific to the PostgreSQL datasource, although it is very similar between datasources and is designed to be generic and extendable.
``` swift
let pturnstile = TurnstilePerfectRealm()
```
Define the connection details to access the MongoDB server:
``` swift
MongoDBConnection.host = "localhost"
MongoDBConnection.database = "perfect_testing"
```
Connect the AccessTokenStore:
``` swift
tokenStore = AccessTokenStore(connect!)
```
Create the HTTP Server:
``` swift
let server = HTTPServer()
```
Register routes and handlers and add the routes to the server:
``` swift
let authWebRoutes = makeWebAuthRoutes()
let authJSONRoutes = makeJSONAuthRoutes("/api/v1")
server.addRoutes(authWebRoutes)
server.addRoutes(authJSONRoutes)
```
Add routes to be checked for authentication:
``` swift
var authenticationConfig = AuthenticationConfig()
authenticationConfig.include("/api/v1/check")
authenticationConfig.exclude("/api/v1/login")
authenticationConfig.exclude("/api/v1/register")
let authFilter = AuthFilter(authenticationConfig)
```
These routes can be either seperate, or as an array of strings. They describe inclusions and exclusions. In a forthcoming release wildcard routes will be supported.
Add request & response filters. Note the order which you specify filters that are of the same priority level:
``` swift
server.setRequestFilters([pturnstile.requestFilter])
server.setResponseFilters([pturnstile.responseFilter])
server.setRequestFilters([(authFilter, .high)])
```
Now, set the port, static files location, and start the server:
``` swift
// Set a listen port of 8181
server.serverPort = 8181
// Where to serve static files from
server.documentRoot = "./webroot"
do {
// Launch the HTTP server.
try server.start()
} catch PerfectError.networkError(let err, let msg) {
print("Network error thrown: \(err) \(msg)")
}
```
## Issues
We use JIRA for all bugs and support related issues, therefore the GitHub issues has been disabled.
If you find a mistake, bug, or any other helpful suggestion you'd like to make on the docs please head over to [http://jira.perfect.org:8080/servicedesk/customer/portal/1](http://jira.perfect.org:8080/servicedesk/customer/portal/1) and raise it.
A comprehensive list of open issues can be found at [http://jira.perfect.org:8080/projects/ISS/issues](http://jira.perfect.org:8080/projects/ISS/issues)
## Further Information
For more information on the Perfect project, please visit [perfect.org](http://perfect.org).