Perfect Local Authentication

服务器端用户身份验证函数库

参考实例

请参考如下链接的模板应用程序：https://github.com/PerfectlySoft/Perfect-Local-Auth-PostgreSQL-Template，内容为完整的函数使用方法展示。

添加组件

欲使用本函数库，请选择如下适当的模块并追加到您项目的Package.swift文件中去。

如果选择以 PostgreSQL 作为数据驱动：

.Package(url: "https://github.com/PerfectlySoft/Perfect-LocalAuthentication-PostgreSQL.git", majorVersion: 3)

如果选择以 MySQL 作为数据驱动：

.Package(url: "https://github.com/PerfectlySoft/Perfect-LocalAuthentication-MySQL.git", majorVersion: 3)

模块配置

具体使用之前，请务必做好模块配置工作（以下例子假设您使用main.swift作为程序入口）。首先导入函数库：

import PerfectSession
import PerfectSessionPostgreSQL // Or PerfectSessionMySQL
import PerfectCrypto
import LocalAuthentication

然后请初始化 PerfectCrypto 加密函数库：

let _ = PerfectCrypto.isInitialized

设置默认选项：

// 以下配置在电子邮件系统中会用上。
// 请设置链接到您自己系统主页的基本地址，比如 http://www.example.com/
var baseURL = ""

// 配置会话过程
SessionConfig.name = "perfectSession" // <-- 请自行设定名称
SessionConfig.idle = 86400
SessionConfig.cookieDomain = "localhost" //<-- 请自行设定主机名
SessionConfig.IPAddressLock = false
SessionConfig.userAgentLock = false
SessionConfig.CSRF.checkState = true
SessionConfig.CORS.enabled = true
SessionConfig.cookieSameSite = .lax

详细的会话过程文档请参考 https://www.perfect.org/docs/sessionszhCN.html

数据库和电邮配置方法参考如下（假设您使用JSON进行配置）：

let opts = initializeSchema("./config/ApplicationConfiguration.json") // <-- 该JSON文件包含数据库和邮件配置信息
httpPort = opts["httpPort"] as? Int ?? httpPort
baseURL = opts["baseURL"] as? String ?? baseURL

否则，请使用下列函数完成等价的配置：

设置会话数据库驱动

PostgreSQL:

let sessionDriver = SessionPostgresDriver()

MySQL:

let sessionDriver = SessionMySQLDriver()

设置请求/响应过滤器

下列两个会话过滤器需要追加到您服务器的配置中：

如果使用 PostgreSQL 作为会话数据库驱动:

// (where filter is a [[String: Any]] object)
filters.append(["type":"request","priority":"high","name":SessionPostgresFilter.filterAPIRequest])
filters.append(["type":"response","priority":"high","name":SessionPostgresFilter.filterAPIResponse])

如果使用 MySQL 作为会话数据库驱动:

// (where filter is a [[String: Any]] object)
filters.append(["type":"request","priority":"high","name":SessionMySQLFilter.filterAPIRequest])
filters.append(["type":"response","priority":"high","name":SessionMySQLFilter.filterAPIResponse])

关于过滤器的使用，请参考范例： https://github.com/PerfectlySoft/Perfect-Local-Auth-PostgreSQL-Template/blob/master/Sources/PerfectLocalAuthPostgreSQLTemplate/configuration/Filters.swift

追加注册及登录函数

请将下列函数句柄追加到服务器路由，用于实现注册、登录和注销命令。

// Login
routes.append(["method":"get", "uri":"/login", "handler":Handlers.login]) // simply a serving of the login GET
routes.append(["method":"post", "uri":"/login", "handler":LocalAuthWebHandlers.login])
routes.append(["method":"get", "uri":"/logout", "handler":LocalAuthWebHandlers.logout])

// Register
routes.append(["method":"get", "uri":"/register", "handler":LocalAuthWebHandlers.register])
routes.append(["method":"post", "uri":"/register", "handler":LocalAuthWebHandlers.registerPost])
routes.append(["method":"get", "uri":"/verifyAccount/{passvalidation}", "handler":LocalAuthWebHandlers.registerVerify])
routes.append(["method":"post", "uri":"/registrationCompletion", "handler":LocalAuthWebHandlers.registerCompletion])

// JSON
routes.append(["method":"get", "uri":"/api/v1/session", "handler":LocalAuthJSONHandlers.session])
routes.append(["method":"get", "uri":"/api/v1/logout", "handler":LocalAuthJSONHandlers.logout])
routes.append(["method":"post", "uri":"/api/v1/register", "handler":LocalAuthJSONHandlers.register])
routes.append(["method":"login", "uri":"/api/v1/login", "handler":LocalAuthJSONHandlers.login])

详细例子可以参考这里： https://github.com/PerfectlySoft/Perfect-Local-Auth-PostgreSQL-Template/blob/master/Sources/PerfectLocalAuthPostgreSQLTemplate/configuration/Routes.swift

测试验证模块是否工作

如果配置成功，您可以通过下列方式获取用户身份编号：

request.session?.userid ?? ""

如果在具体页面实现中需要用户处于登录状态，您可以用下列代码测试用户是否登录；如果没有登录则自动调用登录过程：

let contextAuthenticated = !(request.session?.userid ?? "").isEmpty
if !contextAuthenticated { response.redirect(path: "/login") }
```