Show / Hide Table of Contents

    Class SslCredentials

    Client-side SSL credentials.

    Inheritance
    System.Object
    ChannelCredentials
    SslCredentials
    Inherited Members
    ChannelCredentials.Insecure
    ChannelCredentials.SecureSsl
    ChannelCredentials.Create(ChannelCredentials, CallCredentials)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Grpc.Core
    Assembly: Grpc.Core.Api.dll
    Syntax
    public sealed class SslCredentials : ChannelCredentials

    Constructors

    SslCredentials()

    Creates client-side SSL credentials loaded from disk file pointed to by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable. If that fails, gets the roots certificates from a well known place on disk.

    Declaration
    public SslCredentials()

    SslCredentials(Nullable<String>, Nullable<KeyCertificatePair>, Nullable<VerifyPeerCallback>)

    Creates client-side SSL credentials.

    Declaration
    public SslCredentials(string? rootCertificates, KeyCertificatePair? keyCertificatePair, VerifyPeerCallback? verifyPeerCallback)
    Parameters
    Type Name Description
    System.Nullable<System.String> rootCertificates

    string containing PEM encoded server root certificates.

    System.Nullable<KeyCertificatePair> keyCertificatePair

    a key certificate pair.

    System.Nullable<VerifyPeerCallback> verifyPeerCallback

    a callback to verify peer's target name and certificate.

    SslCredentials(String)

    Creates client-side SSL credentials from a string containing PEM encoded root certificates.

    Declaration
    public SslCredentials(string rootCertificates)
    Parameters
    Type Name Description
    System.String rootCertificates

    SslCredentials(String, KeyCertificatePair)

    Creates client-side SSL credentials.

    Declaration
    public SslCredentials(string rootCertificates, KeyCertificatePair keyCertificatePair)
    Parameters
    Type Name Description
    System.String rootCertificates

    string containing PEM encoded server root certificates.

    KeyCertificatePair keyCertificatePair

    a key certificate pair.

    Properties

    KeyCertificatePair

    Client side key and certificate pair. If null, client will not use key and certificate pair.

    Declaration
    public KeyCertificatePair? KeyCertificatePair { get; }
    Property Value
    Type Description
    System.Nullable<KeyCertificatePair>

    RootCertificates

    PEM encoding of the server root certificates.

    Declaration
    public string? RootCertificates { get; }
    Property Value
    Type Description
    System.Nullable<System.String>

    Methods

    InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase, Object)

    Populates channel credentials configurator with this instance's configuration. End users never need to invoke this method as it is part of internal implementation.

    Declaration
    public override void InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase configurator, object state)
    Parameters
    Type Name Description
    ChannelCredentialsConfiguratorBase configurator
    System.Object state
    Overrides
    ChannelCredentials.InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase, Object)
    Back to top Generated by DocFX