1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
#region Copyright notice and license
// Copyright 2015 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#endregion
using System;
using System.Collections.Generic;
using Grpc.Core.Internal;
using Grpc.Core.Utils;
namespace Grpc.Core
{
/// <summary>
/// Server side credentials.
/// </summary>
public abstract class ServerCredentials
{
static readonly ServerCredentials InsecureInstance = new InsecureServerCredentialsImpl();
/// <summary>
/// Returns instance of credential that provides no security and
/// will result in creating an unsecure server port with no encryption whatsoever.
/// </summary>
public static ServerCredentials Insecure
{
get
{
return InsecureInstance;
}
}
/// <summary>
/// Creates native object for the credentials.
/// </summary>
/// <returns>The native credentials.</returns>
internal abstract ServerCredentialsSafeHandle ToNativeCredentials();
private sealed class InsecureServerCredentialsImpl : ServerCredentials
{
internal override ServerCredentialsSafeHandle ToNativeCredentials()
{
return null;
}
}
}
/// <summary>
/// Modes of requesting client's SSL certificate by the server.
/// Corresponds to <c>grpc_ssl_client_certificate_request_type</c>.
/// </summary>
public enum SslClientCertificateRequestType {
/// <summary>
/// Server does not request client certificate.
/// The certificate presented by the client is not checked by the server at
/// all. (A client may present a self signed or signed certificate or not
/// present a certificate at all and any of those option would be accepted)
/// </summary>
DontRequestClientCertificate = 0,
/// <summary>
/// Server requests client certificate but does not enforce that the client
/// presents a certificate.
/// If the client presents a certificate, the client authentication is left to
/// the application (the necessary metadata will be available to the
/// application via authentication context properties, see grpc_auth_context).
/// The client's key certificate pair must be valid for the SSL connection to
/// be established.
///</summary>
RequestClientCertificateButDontVerify,
/// <summary>
/// Server requests client certificate but does not enforce that the client
/// presents a certificate.
/// If the client presents a certificate, the client authentication is done by
/// the gRPC framework. (For a successful connection the client needs to either
/// present a certificate that can be verified against the root certificate
/// configured by the server or not present a certificate at all)
/// The client's key certificate pair must be valid for the SSL connection to
/// be established.
/// </summary>
RequestClientCertificateAndVerify,
/// <summary>
/// Server requests client certificate and enforces that the client presents a
/// certificate.
/// If the client presents a certificate, the client authentication is left to
/// the application (the necessary metadata will be available to the
/// application via authentication context properties, see grpc_auth_context).
/// The client's key certificate pair must be valid for the SSL connection to
/// be established.
///</summary>
RequestAndRequireClientCertificateButDontVerify,
/// <summary>
/// Server requests client certificate and enforces that the client presents a
/// certificate.
/// The cerificate presented by the client is verified by the gRPC framework.
/// (For a successful connection the client needs to present a certificate that
/// can be verified against the root certificate configured by the server)
/// The client's key certificate pair must be valid for the SSL connection to
/// be established.
/// </summary>
RequestAndRequireClientCertificateAndVerify,
}
/// <summary>
/// Server-side SSL credentials.
/// </summary>
public class SslServerCredentials : ServerCredentials
{
readonly IList<KeyCertificatePair> keyCertificatePairs;
readonly string rootCertificates;
readonly SslClientCertificateRequestType clientCertificateRequest;
/// <summary>
/// Creates server-side SSL credentials.
/// </summary>
/// <param name="keyCertificatePairs">Key-certificates to use.</param>
/// <param name="rootCertificates">PEM encoded client root certificates used to authenticate client.</param>
/// <param name="forceClientAuth">Deprecated, use clientCertificateRequest overload instead.</param>
public SslServerCredentials(IEnumerable<KeyCertificatePair> keyCertificatePairs, string rootCertificates, bool forceClientAuth)
: this(keyCertificatePairs, rootCertificates, forceClientAuth ? SslClientCertificateRequestType.RequestAndRequireClientCertificateAndVerify : SslClientCertificateRequestType.DontRequestClientCertificate)
{
}
/// <summary>
/// Creates server-side SSL credentials.
/// </summary>
/// <param name="keyCertificatePairs">Key-certificates to use.</param>
/// <param name="rootCertificates">PEM encoded client root certificates used to authenticate client.</param>
/// <param name="clientCertificateRequest">Options for requesting and verifying client certificate.</param>
public SslServerCredentials(IEnumerable<KeyCertificatePair> keyCertificatePairs, string rootCertificates, SslClientCertificateRequestType clientCertificateRequest)
{
this.keyCertificatePairs = new List<KeyCertificatePair>(keyCertificatePairs).AsReadOnly();
GrpcPreconditions.CheckArgument(this.keyCertificatePairs.Count > 0,
"At least one KeyCertificatePair needs to be provided.");
if (clientCertificateRequest == SslClientCertificateRequestType.RequestAndRequireClientCertificateAndVerify)
{
GrpcPreconditions.CheckNotNull(rootCertificates,
"Cannot require and verify client certificate unless you provide rootCertificates.");
}
this.rootCertificates = rootCertificates;
this.clientCertificateRequest = clientCertificateRequest;
}
/// <summary>
/// Creates server-side SSL credentials.
/// This constructor should be used if you do not wish to authenticate the client.
/// (client certificate won't be requested and checked by the server at all).
/// </summary>
/// <param name="keyCertificatePairs">Key-certificates to use.</param>
public SslServerCredentials(IEnumerable<KeyCertificatePair> keyCertificatePairs) : this(keyCertificatePairs, null, SslClientCertificateRequestType.DontRequestClientCertificate)
{
}
/// <summary>
/// Key-certificate pairs.
/// </summary>
public IList<KeyCertificatePair> KeyCertificatePairs
{
get
{
return this.keyCertificatePairs;
}
}
/// <summary>
/// PEM encoded client root certificates.
/// </summary>
public string RootCertificates
{
get
{
return this.rootCertificates;
}
}
/// <summary>
/// Deprecated. If true, the authenticity of client check will be enforced.
/// </summary>
public bool ForceClientAuthentication
{
get
{
return this.clientCertificateRequest == SslClientCertificateRequestType.RequestAndRequireClientCertificateAndVerify;
}
}
/// <summary>
/// Mode of requesting certificate from client by the server.
/// </summary>
public SslClientCertificateRequestType ClientCertificateRequest
{
get
{
return this.clientCertificateRequest;
}
}
internal override ServerCredentialsSafeHandle ToNativeCredentials()
{
int count = keyCertificatePairs.Count;
string[] certChains = new string[count];
string[] keys = new string[count];
for (int i = 0; i < count; i++)
{
certChains[i] = keyCertificatePairs[i].CertificateChain;
keys[i] = keyCertificatePairs[i].PrivateKey;
}
return ServerCredentialsSafeHandle.CreateSslCredentials(rootCertificates, certChains, keys, clientCertificateRequest);
}
}
}
|
