certificates

Documentation

Index

• type Client
  • func New(c HTTPClient) *Client
  • func (c *Client) Index(ctx context.Context, req IndexRequest) ([]map[string]interface{}, error)
  • func (c *Client) Info(ctx context.Context, req InfoRequest) ([]InfoResponse, error)
  • func (c *Client) RemoveCustomCertCustom(ctx context.Context, req RemoveCustomCertCustomRequest) error
  • func (c *Client) UploadCustomCertCustom(ctx context.Context, req UploadCustomCertCustomRequest) (UploadCustomCertCustomResponse, error)
• type HTTPClient
• type IndexRequest
• type InfoRequest
• type InfoResponse
• type RemoveCustomCertCustomRequest
• type UploadCustomCertCustomRequest
• type UploadCustomCertCustomResponse

Types

type Client

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

func New

func New(c HTTPClient) *Client

func (*Client) Index

func (c *Client) Index(ctx context.Context, req IndexRequest) ([]map[string]interface{}, error)

Index Node index.

func (*Client) Info

func (c *Client) Info(ctx context.Context, req InfoRequest) ([]InfoResponse, error)

Info Get information about node's certificates.

func (*Client) RemoveCustomCertCustom

func (c *Client) RemoveCustomCertCustom(ctx context.Context, req RemoveCustomCertCustomRequest) error

RemoveCustomCertCustom DELETE custom certificate chain and key.

func (*Client) UploadCustomCertCustom

func (c *Client) UploadCustomCertCustom(ctx context.Context, req UploadCustomCertCustomRequest) (UploadCustomCertCustomResponse, error)

UploadCustomCertCustom Upload or update custom certificate chain and key.

type HTTPClient

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexRequest

type IndexRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type InfoRequest

type InfoRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

}

type InfoResponse

type InfoResponse struct {

	// The following parameters are optional
	Filename      *string   `url:"filename,omitempty" json:"filename,omitempty"`
	Fingerprint   *string   `url:"fingerprint,omitempty" json:"fingerprint,omitempty"`         // Certificate SHA 256 fingerprint.
	Issuer        *string   `url:"issuer,omitempty" json:"issuer,omitempty"`                   // Certificate issuer name.
	Notafter      *int      `url:"notafter,omitempty" json:"notafter,omitempty"`               // Certificate's notAfter timestamp (UNIX epoch).
	Notbefore     *int      `url:"notbefore,omitempty" json:"notbefore,omitempty"`             // Certificate's notBefore timestamp (UNIX epoch).
	Pem           *string   `url:"pem,omitempty" json:"pem,omitempty"`                         // Certificate in PEM format
	PublicKeyBits *int      `url:"public-key-bits,omitempty" json:"public-key-bits,omitempty"` // Certificate's public key size
	PublicKeyType *string   `url:"public-key-type,omitempty" json:"public-key-type,omitempty"` // Certificate's public key algorithm
	San           *[]string `url:"san,omitempty" json:"san,omitempty"`                         // List of Certificate's SubjectAlternativeName entries.
	Subject       *string   `url:"subject,omitempty" json:"subject,omitempty"`                 // Certificate subject name.
}

type RemoveCustomCertCustomRequest

type RemoveCustomCertCustomRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Restart *util.PVEBool `url:"restart,omitempty" json:"restart,omitempty"` // Restart pveproxy.
}

type UploadCustomCertCustomRequest

type UploadCustomCertCustomRequest struct {
	Certificates string `url:"certificates" json:"certificates"` // PEM encoded certificate (chain).
	Node         string `url:"node" json:"node"`                 // The cluster node name.

	// The following parameters are optional
	Force   *util.PVEBool `url:"force,omitempty" json:"force,omitempty"`     // Overwrite existing custom or ACME certificate files.
	Key     *string       `url:"key,omitempty" json:"key,omitempty"`         // PEM encoded private key.
	Restart *util.PVEBool `url:"restart,omitempty" json:"restart,omitempty"` // Restart pveproxy.
}

type UploadCustomCertCustomResponse

type UploadCustomCertCustomResponse struct {

	// The following parameters are optional
	Filename      *string   `url:"filename,omitempty" json:"filename,omitempty"`
	Fingerprint   *string   `url:"fingerprint,omitempty" json:"fingerprint,omitempty"`         // Certificate SHA 256 fingerprint.
	Issuer        *string   `url:"issuer,omitempty" json:"issuer,omitempty"`                   // Certificate issuer name.
	Notafter      *int      `url:"notafter,omitempty" json:"notafter,omitempty"`               // Certificate's notAfter timestamp (UNIX epoch).
	Notbefore     *int      `url:"notbefore,omitempty" json:"notbefore,omitempty"`             // Certificate's notBefore timestamp (UNIX epoch).
	Pem           *string   `url:"pem,omitempty" json:"pem,omitempty"`                         // Certificate in PEM format
	PublicKeyBits *int      `url:"public-key-bits,omitempty" json:"public-key-bits,omitempty"` // Certificate's public key size
	PublicKeyType *string   `url:"public-key-type,omitempty" json:"public-key-type,omitempty"` // Certificate's public key algorithm
	San           *[]string `url:"san,omitempty" json:"san,omitempty"`                         // List of Certificate's SubjectAlternativeName entries.
	Subject       *string   `url:"subject,omitempty" json:"subject,omitempty"`                 // Certificate subject name.
}