Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AttemptSecured

func AttemptSecured(url string, allowInSecure bool) bool

    AttemptSecured is a utility function which verifies URL and returns if secured connections needs to established for protocol 'grpcs' in URL returns true for protocol 'grpc' in URL returns false for no protocol mentioned, returns !allowInSecure

    func IsTLSEnabled

    func IsTLSEnabled(url string) bool

      IsTLSEnabled is a generic function that expects a URL and verifies if it has a prefix HTTPS or GRPCS to return true for TLS Enabled URLs or false otherwise

      func ToAddress

      func ToAddress(url string) string

        ToAddress is a utility function to trim the GRPC protocol prefix as it is not needed by GO if the GRPC protocol is not found, the url is returned unchanged

        Types

        type MutualTLSConfig

        type MutualTLSConfig struct {
        	Pem []string
        	// Certfiles root certificates for TLS validation (Comma separated path list)
        	Path string
        
        	//Client TLS information
        	Client TLSKeyPair
        }

          MutualTLSConfig Mutual TLS configurations

          type TLSConfig

          type TLSConfig struct {
          	// the following two fields are interchangeable.
          	// If Path is available, then it will be used to load the cert
          	// if Pem is available, then it has the raw data of the cert it will be used as-is
          	// Certificate root certificate path
          	// If both Path and Pem are available, pem takes the precedence
          	Path string
          	// Certificate actual content
          	Pem string
          	// contains filtered or unexported fields
          }

            TLSConfig TLS configuration used in the sdk's configs.

            func (*TLSConfig) Bytes

            func (cfg *TLSConfig) Bytes() []byte

              Bytes returns the tls certificate as a byte array

              func (*TLSConfig) LoadBytes

              func (cfg *TLSConfig) LoadBytes() error

                LoadBytes preloads bytes from Pem/Path Pem takes precedence over Path

                func (*TLSConfig) TLSCert

                func (cfg *TLSConfig) TLSCert() (*x509.Certificate, bool, error)

                  TLSCert returns the tls certificate as a *x509.Certificate by loading it either from the embedded Pem or Path

                  type TLSKeyPair

                  type TLSKeyPair struct {
                  	Key  TLSConfig
                  	Cert TLSConfig
                  }

                    TLSKeyPair contains the private key and certificate for TLS encryption

                    Source Files