Vapor 2.0 - 认证入门(Getting Started)

前往 Vapor 2.0 - 文档目录

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)。

瞧一瞧
我们省略大部分ModelPreparation协议要求。有关这些协议的更多信息,请查看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部分,了解有关不同类型身份验证的更多信息。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容