blob: ac2a37d75f2121bbe46383e055041a0c0c4cb9e3 [file] [log] [blame]
Paul Querna40f11aa2016-03-03 23:09:06 -08001/*
2 *
3 * Copyright 2016, Google Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
34#import "GRPCCall.h"
35
Muxi Yan2c88b462016-10-28 10:47:25 -070036/** Helpers for setting TLS Trusted Roots, Client Certificates, and Private Key */
Paul Querna40f11aa2016-03-03 23:09:06 -080037@interface GRPCCall (ChannelCredentials)
38
39/**
Muxi Yan2c88b462016-10-28 10:47:25 -070040 * Use the provided @c pemRootCert as the set of trusted root Certificate Authorities for @c host.
Paul Querna40f11aa2016-03-03 23:09:06 -080041 */
42+ (BOOL)setTLSPEMRootCerts:(nullable NSString *)pemRootCert
43 forHost:(nonnull NSString *)host
Muxi Yan2c88b462016-10-28 10:47:25 -070044 error:(NSError * _Nullable * _Nullable)errorPtr;
Paul Querna40f11aa2016-03-03 23:09:06 -080045/**
Muxi Yan2c88b462016-10-28 10:47:25 -070046 * Configures @c host with TLS/SSL Client Credentials and optionally trusted root Certificate
47 * Authorities. If @c pemRootCerts is nil, the default CA Certificates bundled with gRPC will be
48 * used.
Paul Querna40f11aa2016-03-03 23:09:06 -080049 */
50+ (BOOL)setTLSPEMRootCerts:(nullable NSString *)pemRootCerts
51 withPrivateKey:(nullable NSString *)pemPrivateKey
52 withCertChain:(nullable NSString *)pemCertChain
53 forHost:(nonnull NSString *)host
Muxi Yan2c88b462016-10-28 10:47:25 -070054 error:(NSError * _Nullable * _Nullable)errorPtr;
Paul Querna40f11aa2016-03-03 23:09:06 -080055
56@end