Vapor的Auth Provider软件使得实现认证和授权变得简单而安全。它支持常见的验证模式,如:
- Token (bearer) authentication 令牌(承载)认证
- Username + password (basic) authentication 用户名+密码(基本)认证
- Permission-based authorization 基于权限的授权
- Session-based persistance 基于会话的持久性
Auth的模块化,基于协议的性质也使其成为定制认证需求的良好基础。
提示
使用vapor new <name> --template=vapor/auth-template
创建一个新的带示例代码的AuthProvider项目模板。
包(Package)
要使用Auth,您需要将Auth Provider添加到您的项目中。这就像在` Package.swift文件中添加以下行一样简单。
.Package(url: "https://github.com/vapor/auth-provider.git", ...)
查看使用认证(Package) 部分了解更多信息。
示例(Example)
我们来看看我们如何使用Vapor和Auth实现一个简单的,基于令牌(token-based)的验证系统。
用户(User)
我们将首先创建一个模型来表示我们的用户。如果你已经有一个用户类,你可以跳过这个步骤。
import Vapor
import FluentProvider
final class ExampleUser: Model {
let name: String
...
}
extension ExampleUser: Preparation { ... }
这里我们创建一个非常简单的用户,只有一个属性:一个名称(name)。
瞧一瞧
我们省略大部分Model
和Preparation
协议要求。有关这些协议的更多信息,请查看Fluent入门指南(Getting Started) 。
令牌(Token)
接下来,我们创建一个模型来表示我们的身份验证令牌。这些将存储在单独的数据库表或集合中,称为“令牌(tokens)”。
当用户登录时,我们将为它们创建一个新的令牌。然后,他们将在后续请求中使用此令牌,而不是其用户名和密码。
现在,这就是我们的简单的令牌模型。
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):我们将在请求中发送的唯一的随机字符串
- userId:此令牌所属的用户的标识符
瞧一瞧
我们在这里使用Fluent relations。查看关系(Relations) 部分了解更多信息。
令牌认证(Token Authenticatable)
现在我们有我们的示例用户和令牌,我们可以让我们的用户使用令牌进行认证。
这可能听起来很复杂,但实际上很简单:
import AuthProvider
extension ExampleUser: TokenAuthenticatable {
// the token model that should be queried
// to authenticate this user
public typealias TokenType = ExampleToken
}
现在我们的示例用户是TokenAuthenticatable
,我们可以继续下一步!
用户助手(User Helper)
让我们添加一个简单的便利方法来请求访问经过身份验证的用户。
extension Request {
func user() throws -> ExampleUser {
return try auth.assertAuthenticated()
}
}
这是一个很好的捷径,将在几个步骤中派上用场。
中间件(Middleware)
要求认证,我们需要添加 TokenAuthenticationMiddleware
。您可以将此中间件应用于单个路由或整个Droplet。为了简单起见,我们将其应用于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)
现在我们有一个由我们的TokenMiddleware保护的路由组,我们添加一个路由来返回经过身份验证的用户名。
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)
数据库(Database)
就是这样!我们现在有一个功能认证系统。让我们几个条目添加到数据库,并对其进行测试。
用户(Users)
id | name |
---|---|
1 | Bob |
令牌(Tokens)
id | token | user_id |
---|---|---|
1 | foo | 1 |
请求(Request)
现在我们可以向我们的Vapor应用程序发出请求。
GET /me HTTP/1.1
Authorization: Bearer foo
我们应该得到一个回应。
HTTP/1.1 200 OK
Content-Type: text/plain
Bob
坏令牌(Bad Token)
为了确保它的安全性,让我们使用不在我们的数据库中的令牌进行测试。
GET /me HTTP/1.1
Authorization: Bearer not-a-token
我们应该得到一个回应。
HTTP/1.1 403 Forbidden
下一步(Next Steps)
要将其构建到生产就绪认证系统中,您将需要构建一些额外的路由来创建用户和创建令牌。
继续阅读Auth部分,了解有关不同类型身份验证的更多信息。
网友评论