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.66.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

（这可能必须编译 OpenSSL，如果 CocoaPods 尚未将其缓存在您的计算机上，则大约需要 15 分钟）。

最后，打开 CocoaPods 创建的 XCode 工作区，并运行该应用程序。

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

• 查看您的电子邮件地址。
• 查看您的基本个人资料信息。
• “访问动物园服务的测试范围”。

最后一个权限，对应于范围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);
}

AUTHTestService 类会生成一个 unaryCallWithMessage:responseHandler:callOptions: 方法，您已经熟悉此方法。

- (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];

当调用启动时，它将使用回调 handler 调用 TokenProvider 实例的 getTokenWithHandler: 方法，并等待回调。TokenProvider 实例可以在任何时候调用处理程序，为此调用提供令牌并恢复调用过程。