OAuth2

本示例演示了如何在 gRPC 上使用 OAuth2 代表用户进行身份验证的 API 调用。

通过本示例，您还将学习如何使用 Objective-C gRPC API：

• 在 RPC 启动之前初始化和配置远程调用对象。
• 在调用中设置请求元数据元素，这些元素在语义上等同于 HTTP 请求头。
• 从调用中读取响应元数据，这等同于 HTTP 响应头和尾部信息。

本示例假设您了解如何使用 Objective-C 客户端库进行 gRPC API 调用的基础知识，如基础教程和gRPC 简介中所述，并且熟悉 OAuth2 概念，例如访问令牌。

示例代码和设置

示例源代码请参阅gprc/examples/objective-c/auth_sample。要下载示例，请运行以下命令克隆此仓库：

git clone -b v1.74.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc
cd grpc
git submodule update --init

然后将当前目录更改为 examples/objective-c/auth_sample

cd examples/objective-c/auth_sample

我们的示例是一个包含两个视图的简单应用程序。第一个视图允许用户使用 Google 的iOS 登录库的 OAuth2 流程进行登录和注销。（本示例使用 Google 的库，因为我们即将调用的测试 gRPC 服务需要 Google 账户凭据，但 gRPC 和 Objective-C 客户端库均不与任何特定的 OAuth2 提供商绑定）。第二个视图使用第一个视图获取的访问令牌向测试服务器发出 gRPC 请求。

与其他 Objective-C 示例一样，您还应该安装CocoaPods，以及生成客户端库代码的相关工具。您可以通过遵循这些设置说明来获取后者。

尝试一下！

要尝试此示例应用，首先让 CocoaPods 为我们的 .proto 文件生成并安装客户端库：

pod install

（如果 CocoaPods 在您的计算机缓存中还没有 OpenSSL，则可能需要编译 OpenSSL，这大约需要 15 分钟）。

最后，打开 CocoaPods 创建的 Xcode 工作区，然后运行应用程序。

第一个视图 SelectUserViewController.h/m，要求您使用 Google 账户登录，并授予“gRPC-AuthSample”应用以下权限：

• 查看您的电子邮件地址。
• 查看您的基本资料信息。
• “用于访问 Zoo 服务的测试范围”。

最后这项权限，对应于范围 https://www.googleapis.com/auth/xapi.zoo，不授予任何实际功能：它仅用于测试。您可以随时注销。

第二个视图 MakeRPCViewController.h/m，向测试服务器 https://grpc-test.sandbox.google.com 发出 gRPC 请求，并随请求发送访问令牌。测试服务会简单地验证令牌，并在其响应中写入该令牌所属的用户以及授予访问权限的范围。（客户端应用程序已知道这两个值；这是一种验证一切是否按预期进行的方式）。

以下部分将逐步指导您了解 MakeRPCViewController 中 gRPC 调用的执行方式。您可以在MakeRPCViewController.m中查看完整的代码。

使用访问令牌创建调用

要进行身份验证的调用，首先需要初始化一个 GRPCCallOptions 对象，并使用访问令牌对其进行配置。

GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
options.oauth2AccessToken = myAccessToken;

然后，您需要使用此调用选项对象创建并启动您的调用。假设您有一个 proto 服务定义如下：

option objc_class_prefix = "AUTH";

service TestService {
  rpc UnaryCall(Request) returns (Response);
}

一个 unaryCallWithMessage:responseHandler:callOptions: 方法，您应该已经很熟悉了，它是为 AUTHTestService 类生成的。

- (GRPCUnaryProtoRPC *)unaryCallWithMessage:(AUTHRequest *)message
                            responseHandler:(id<GRPCProtoResponseHandler>)responseHandler
                                callOptions:(GRPCCallOptions *)callOptions;

使用此方法通过您的请求选项对象生成 RPC 对象：

GRPCUnaryProtoRPC *rpc = [client unaryCallWithMessage:myRequestMessage
                                      responseHandler:myResponseHandler
                                          callOptions:options];

然后，您可以随时启动此对象所代表的 RPC，如下所示：

[rpc start];

提供访问令牌的另一种方法

除了在 RPC 对象创建之前在 GRPCCallOptions 中设置 oauth2AccessToken 选项之外，另一种方法允许用户在调用开始时提供访问令牌。

要使用此方法，首先在您的项目中创建一个符合 GRPCAuthorizationProtocol 协议的类。

@interface TokenProvider : NSObject<GRPCAuthorizationProtocol>
...
@end

@implementation TokenProvider

- (void)getTokenWithHandler:(void (^)(NSString* token))handler {
  ...
}

@end

创建 RPC 对象时，将此类的实例传递给调用选项 authTokenProvider：

GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
options.authTokenProvider = [[TokenProvider alloc] init];
GRPCUnaryProtoCall *rpc = [client unaryCallWithMessage:myRequestMessage
                                       responseHandler:myResponseHandler
                                           callOptions:options] start];
[rpc start];

当调用开始时，它将调用 TokenProvider 实例的 getTokenWithHandler: 方法，带有一个回调 handler，并等待回调。该 TokenProvider 实例可以随时调用该处理程序，为此调用提供令牌并恢复调用过程。