Vapor的Auth Provider軟件使得實現(xiàn)認證和授權(quán)變得簡單而安全。它支持常見的驗證模式牢贸,如:
- Token (bearer) authentication 令牌(承載)認證
- Username + password (basic) authentication 用戶名+密碼(基本)認證
- Permission-based authorization 基于權(quán)限的授權(quán)
- Session-based persistance 基于會話的持久性
Auth的模塊化,基于協(xié)議的性質(zhì)也使其成為定制認證需求的良好基礎(chǔ)审胸。
提示
使用vapor new <name> --template=vapor/auth-template
創(chuàng)建一個新的帶示例代碼的AuthProvider項目模板梭纹。
包(Package)
要使用Auth捺僻,您需要將Auth Provider添加到您的項目中恋技。這就像在` Package.swift文件中添加以下行一樣簡單拇舀。
.Package(url: "https://github.com/vapor/auth-provider.git", ...)
查看使用認證(Package) 部分了解更多信息。
示例(Example)
我們來看看我們?nèi)绾问褂肰apor和Auth實現(xiàn)一個簡單的蜻底,基于令牌(token-based)的驗證系統(tǒng)骄崩。
用戶(User)
我們將首先創(chuàng)建一個模型來表示我們的用戶。如果你已經(jīng)有一個用戶類薄辅,你可以跳過這個步驟要拂。
import Vapor
import FluentProvider
final class ExampleUser: Model {
let name: String
...
}
extension ExampleUser: Preparation { ... }
這里我們創(chuàng)建一個非常簡單的用戶,只有一個屬性:一個名稱(name)长搀。
瞧一瞧
我們省略大部分Model
和Preparation
協(xié)議要求宇弛。有關(guān)這些協(xié)議的更多信息石窑,請查看Fluent入門指南(Getting Started) 杠园。
令牌(Token)
接下來馏臭,我們創(chuàng)建一個模型來表示我們的身份驗證令牌。這些將存儲在單獨的數(shù)據(jù)庫表或集合中谁尸,稱為“令牌(tokens)”。
當(dāng)用戶登錄時纽甘,我們將為它們創(chuàng)建一個新的令牌良蛮。然后,他們將在后續(xù)請求中使用此令牌悍赢,而不是其用戶名和密碼决瞳。
現(xiàn)在货徙,這就是我們的簡單的令牌模型。
import Vapor
import FluentProvider
final class ExampleToken: Model {
let token: String
let userId: Identifier
var user: Parent<ExampleToken, ExampleUser> {
return parent(id: userId)
}
...
}
extension ExampleToken: Preparation { ... }
該令牌有兩個屬性:
- 令牌(token):我們將在請求中發(fā)送的唯一的隨機字符串
- userId:此令牌所屬的用戶的標識符
瞧一瞧
我們在這里使用Fluent relations皮胡。查看關(guān)系(Relations) 部分了解更多信息痴颊。
令牌認證(Token Authenticatable)
現(xiàn)在我們有我們的示例用戶和令牌,我們可以讓我們的用戶使用令牌進行認證屡贺。
這可能聽起來很復(fù)雜蠢棱,但實際上很簡單:
import AuthProvider
extension ExampleUser: TokenAuthenticatable {
// the token model that should be queried
// to authenticate this user
public typealias TokenType = ExampleToken
}
現(xiàn)在我們的示例用戶是TokenAuthenticatable
,我們可以繼續(xù)下一步甩栈!
用戶助手(User Helper)
讓我們添加一個簡單的便利方法來請求訪問經(jīng)過身份驗證的用戶泻仙。
extension Request {
func user() throws -> ExampleUser {
return try auth.assertAuthenticated()
}
}
這是一個很好的捷徑,將在幾個步驟中派上用場量没。
中間件(Middleware)
要求認證玉转,我們需要添加 TokenAuthenticationMiddleware
。您可以將此中間件應(yīng)用于單個路由或整個Droplet殴蹄。為了簡單起見冤吨,我們將其應(yīng)用于Droplet。
import Vapor
import AuthProvider
import FluentProvider
let config = try Config()
config.preparations.append(ExampleUser.self)
config.preparations.append(ExampleToken.self)
let drop = try Droplet(config)
let tokenMiddleware = TokenAuthenticationMiddleware(ExampleUser.self)
/// use this route group for protected routes將此路由組用于受保護的路由
let authed = drop.grouped(tokenMiddleware)
由于我們的ExampleUser
類是TokenAuthenticatable
饶套,我們可以將其傳遞給中間件的init方法漩蟆。
** 瞧一瞧**
如果您只想要對某些路由進行身份驗證,請查看
路由文檔中的Route Group部分妓蛮。
路由(Route)
現(xiàn)在我們有一個由我們的TokenMiddleware保護的路由組怠李,我們添加一個路由來返回經(jīng)過身份驗證的用戶名。
authed.get("me") { req in
// return the authenticated user's name
return try req.user().name
}
提示
我們正在使用.user()
我們在Request
這里添加的方便蛤克。這是一個捷徑let user = try req.auth.assertAuthenticated(ExampleUser.self)
數(shù)據(jù)庫(Database)
就是這樣!我們現(xiàn)在有一個功能認證系統(tǒng)捺癞。讓我們幾個條目添加到數(shù)據(jù)庫,并對其進行測試。
用戶(Users)
id | name |
---|---|
1 | Bob |
令牌(Tokens)
id | token | user_id |
---|---|---|
1 | foo | 1 |
請求(Request)
現(xiàn)在我們可以向我們的Vapor應(yīng)用程序發(fā)出請求构挤。
GET /me HTTP/1.1
Authorization: Bearer foo
我們應(yīng)該得到一個回應(yīng)髓介。
HTTP/1.1 200 OK
Content-Type: text/plain
Bob
壞令牌(Bad Token)
為了確保它的安全性,讓我們使用不在我們的數(shù)據(jù)庫中的令牌進行測試筋现。
GET /me HTTP/1.1
Authorization: Bearer not-a-token
我們應(yīng)該得到一個回應(yīng)唐础。
HTTP/1.1 403 Forbidden
下一步(Next Steps)
要將其構(gòu)建到生產(chǎn)就緒認證系統(tǒng)中,您將需要構(gòu)建一些額外的路由來創(chuàng)建用戶和創(chuàng)建令牌矾飞。
繼續(xù)閱讀Auth部分一膨,了解有關(guān)不同類型身份驗證的更多信息。