#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 { /// /// Server side credentials. /// public abstract class ServerCredentials { static readonly ServerCredentials InsecureInstance = new InsecureServerCredentialsImpl(); /// /// Returns instance of credential that provides no security and /// will result in creating an unsecure server port with no encryption whatsoever. /// public static ServerCredentials Insecure { get { return InsecureInstance; } } /// /// Creates native object for the credentials. /// /// The native credentials. internal abstract ServerCredentialsSafeHandle ToNativeCredentials(); private sealed class InsecureServerCredentialsImpl : ServerCredentials { internal override ServerCredentialsSafeHandle ToNativeCredentials() { return null; } } } /// /// Modes of requesting client's SSL certificate by the server. /// Corresponds to grpc_ssl_client_certificate_request_type. /// public enum SslClientCertificateRequestType { /// /// 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) /// DontRequest = 0, /// /// 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. /// RequestButDontVerify, /// /// 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. /// RequestAndVerify, /// /// 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. /// RequestAndRequireButDontVerify, /// /// 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. /// RequestAndRequireAndVerify, } /// /// Server-side SSL credentials. /// public class SslServerCredentials : ServerCredentials { readonly IList keyCertificatePairs; readonly string rootCertificates; readonly SslClientCertificateRequestType clientCertificateRequest; /// /// Creates server-side SSL credentials. /// /// Key-certificates to use. /// PEM encoded client root certificates used to authenticate client. /// Deprecated, use clientCertificateRequest overload instead. public SslServerCredentials(IEnumerable keyCertificatePairs, string rootCertificates, bool forceClientAuth) : this(keyCertificatePairs, rootCertificates, forceClientAuth ? SslClientCertificateRequestType.RequestAndRequireAndVerify : SslClientCertificateRequestType.DontRequest) { } /// /// Creates server-side SSL credentials. /// /// Key-certificates to use. /// PEM encoded client root certificates used to authenticate client. /// Options for requesting and verifying client certificate. public SslServerCredentials(IEnumerable keyCertificatePairs, string rootCertificates, SslClientCertificateRequestType clientCertificateRequest) { this.keyCertificatePairs = new List(keyCertificatePairs).AsReadOnly(); GrpcPreconditions.CheckArgument(this.keyCertificatePairs.Count > 0, "At least one KeyCertificatePair needs to be provided."); if (clientCertificateRequest == SslClientCertificateRequestType.RequestAndRequireAndVerify) { GrpcPreconditions.CheckNotNull(rootCertificates, "Cannot require and verify client certificate unless you provide rootCertificates."); } this.rootCertificates = rootCertificates; this.clientCertificateRequest = clientCertificateRequest; } /// /// 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). /// /// Key-certificates to use. public SslServerCredentials(IEnumerable keyCertificatePairs) : this(keyCertificatePairs, null, SslClientCertificateRequestType.DontRequest) { } /// /// Key-certificate pairs. /// public IList KeyCertificatePairs { get { return this.keyCertificatePairs; } } /// /// PEM encoded client root certificates. /// public string RootCertificates { get { return this.rootCertificates; } } /// /// Deprecated. If true, the authenticity of client check will be enforced. /// public bool ForceClientAuthentication { get { return this.clientCertificateRequest == SslClientCertificateRequestType.RequestAndRequireAndVerify; } } /// /// Mode of requesting certificate from client by the server. /// 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); } } }