certificates

Documentation

Overview

Get SSL certificates.

Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including:

- Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters

The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.

The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.

NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.

If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.

Index

• Variables
• type Certificates
  • func New(tp elastictransport.Interface) *Certificates
  • func (r Certificates) Do(providedCtx context.Context) (Response, error)
  • func (r *Certificates) ErrorTrace(errortrace bool) *Certificates
  • func (r *Certificates) FilterPath(filterpaths ...string) *Certificates
  • func (r *Certificates) Header(key, value string) *Certificates
  • func (r *Certificates) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Certificates) Human(human bool) *Certificates
  • func (r Certificates) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Certificates) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Certificates) Pretty(pretty bool) *Certificates
• type NewCertificates
  • func NewCertificatesFunc(tp elastictransport.Interface) NewCertificates
• type Response
  • func NewResponse() Response

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type Certificates

type Certificates struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Certificates

Get SSL certificates.

Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including:

- Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters

The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.

The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.

NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.

If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html

func (Certificates) Do

func (r Certificates) Do(providedCtx context.Context) (Response, error)

Do runs the request through the transport, handle the response and returns a certificates.Response

func (*Certificates) ErrorTrace

func (r *Certificates) ErrorTrace(errortrace bool) *Certificates

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Certificates) FilterPath

func (r *Certificates) FilterPath(filterpaths ...string) *Certificates

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Certificates) Header

func (r *Certificates) Header(key, value string) *Certificates

Header set a key, value pair in the Certificates headers map.

func (*Certificates) HttpRequest

func (r *Certificates) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Certificates) Human

func (r *Certificates) Human(human bool) *Certificates

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (Certificates) IsSuccess

func (r Certificates) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (Certificates) Perform

func (r Certificates) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Certificates) Pretty

func (r *Certificates) Pretty(pretty bool) *Certificates

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewCertificates

type NewCertificates func() *Certificates

NewCertificates type alias for index.

func NewCertificatesFunc

func NewCertificatesFunc(tp elastictransport.Interface) NewCertificates

NewCertificatesFunc returns a new instance of Certificates with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response []types.CertificateInformation

func NewResponse

func NewResponse() Response

NewResponse returns a Response