blob: c0d36b52310ae29861f3e9048593b2abba6f0401 [file] [log] [blame]
Paul Querna40f11aa2016-03-03 23:09:06 -08001/*
2 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +02003 * Copyright 2016 gRPC authors.
Paul Querna40f11aa2016-03-03 23:09:06 -08004 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +02005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Paul Querna40f11aa2016-03-03 23:09:06 -08008 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +02009 * http://www.apache.org/licenses/LICENSE-2.0
Paul Querna40f11aa2016-03-03 23:09:06 -080010 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +020011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
Paul Querna40f11aa2016-03-03 23:09:06 -080016 *
17 */
18
19#import "GRPCCall.h"
20
Muxi Yan2c88b462016-10-28 10:47:25 -070021/** Helpers for setting TLS Trusted Roots, Client Certificates, and Private Key */
Paul Querna40f11aa2016-03-03 23:09:06 -080022@interface GRPCCall (ChannelCredentials)
23
24/**
Muxi Yan2c88b462016-10-28 10:47:25 -070025 * Use the provided @c pemRootCert as the set of trusted root Certificate Authorities for @c host.
Paul Querna40f11aa2016-03-03 23:09:06 -080026 */
27+ (BOOL)setTLSPEMRootCerts:(nullable NSString *)pemRootCert
28 forHost:(nonnull NSString *)host
Muxi Yan2c88b462016-10-28 10:47:25 -070029 error:(NSError * _Nullable * _Nullable)errorPtr;
Paul Querna40f11aa2016-03-03 23:09:06 -080030/**
Muxi Yan2c88b462016-10-28 10:47:25 -070031 * Configures @c host with TLS/SSL Client Credentials and optionally trusted root Certificate
32 * Authorities. If @c pemRootCerts is nil, the default CA Certificates bundled with gRPC will be
33 * used.
Paul Querna40f11aa2016-03-03 23:09:06 -080034 */
35+ (BOOL)setTLSPEMRootCerts:(nullable NSString *)pemRootCerts
36 withPrivateKey:(nullable NSString *)pemPrivateKey
37 withCertChain:(nullable NSString *)pemCertChain
38 forHost:(nonnull NSString *)host
Muxi Yan2c88b462016-10-28 10:47:25 -070039 error:(NSError * _Nullable * _Nullable)errorPtr;
Paul Querna40f11aa2016-03-03 23:09:06 -080040
41@end