types

Documentation

Index

• type CABasicConstraints
• type CertificateListResponse
• type CreateCertReq
• type CreateCertificateData
• type CreateCertificateResponse
• type IntermediateRequest
• type PEMCertificate
• type PEMCertificateBundle
• type PEMIntermediate
• type RevokeRequest
• type RevokedCertificate
• type SSHCertificate
• type SSHCertificateList
• type SSHCriticalOptions
• type SSHRevokeRequest
• type SSHSignRequest
• type SSHSignResponse
• type SSHTemplate
• type SignRequest
• type SubjectFields
• type Template
• type TemplateListResponse

Types

type CABasicConstraints

type CABasicConstraints struct {
	CA                bool `json:"ca,omitempty"`
	PathLenConstraint int  `json:"pathLenConstraint,omitempty"`
}

CABasicConstraints -------------------------------------------------------- Data structure used for marshaling CA specific information into a CSR

type CertificateListResponse

type CertificateListResponse struct {
	Certificates []string `json:"certificates"`
}

CertificateListResponse ----------------------------------------------------- A structure that contains a JSON representation of certificate serial number strings returned as the response for endpoint '/certificates'

type CreateCertReq

type CreateCertReq struct {
	TemplateName string   `json:"templateName"`
	CommonName   string   `json:"commonName"`
	TTL          int64    `json:"ttl"`
	AltNames     []string `json:"altNames,omitempty"`
}

CreateCertReq --------------------------------------------------------------- Structure that represents an actual certificate request corresponding to the JSON body from the '/certificate/create' endpoint

type CreateCertificateData

type CreateCertificateData struct {
	Certificate          string `json:"certificate"`
	Revoked              bool   `json:"revoked"`
	RevocationDate       string `json:"revocationDate"`
	RevocationReasonCode int    `json:"revocationReasonCode"`
	ExpirationDate       string `json:"expirationDate"`
	SerialNumber         string `json:"serialNumber"`
	InternalState        string `json:"internalState"`
}

CreateCertificateData --------------------------------------------------- Structure that correspond to all the new certificate data that is written to the storage backend used by endpoints '/certificate/create' and 'certificate/sign'

type CreateCertificateResponse

type CreateCertificateResponse struct {
	Certificate   string `json:"certificate"`
	PrivateKey    string `json:"privateKey,omitempty"`
	CACert        string `json:"caCertificate"`
	SerialNumber  string `json:"serialNumber"`
	LeaseDuration int64  `json:"leaseDuration"`
}

CreateCertificateResponse --------------------------------------------------- Structure that respresents the JSON response that is returned from the '/certificate/create' and '/certificate/sign' endpoints

type IntermediateRequest

type IntermediateRequest struct {
	CommonName string        `json:"commonName"`
	KeyAlgo    string        `json:"keyAlgo"`
	KeyBits    string        `json:"keyBits"`
	MaxTTL     int64         `json:"maxTTL"`
	Subject    SubjectFields `json:"subject"`
	AltNames   []string      `json:"altNames,omitempty"`
	SelfSigned bool          `json:"selfSigned,omitempty"`
}

IntermediateRequest -------------------------------------------------------- Structure that represents an intermediate CA certificate request corresponding to the JSON body from the '/ca/generate' endpoint

type PEMCertificate

type PEMCertificate struct {
	Certificate string `json:"certificate"`
}

PEMCertificate ----------------------------------------------------------------- Structure representing a single PEM-encoded X.509 certificate

type PEMCertificateBundle

type PEMCertificateBundle struct {
	CertBundle string `json:"certBundle"`
}

PEMCertificateBundle ----------------------------------------------------------- Structure representing a PEM-bundle of X.509 certificates

type PEMIntermediate

type PEMIntermediate struct {
	CSR            string `json:"csr,omitempty"`
	SelfSignedCert string `json:"selfSignedCert,omitempty"`
}

PEMIntermediate ---------------------------------------------------------------- Structure representing a new PEM-encoded intermediate response from the '/ca/generate' endpoint. The CSR property will be set unless generating a self-signed CA

type RevokeRequest

type RevokeRequest struct {
	SerialNumber string `json:"serialNumber"`
	Reason       string `json:"reason,omitempty"`
}

RevokeRequest -------------------------------------------------------------- Structure that represents a certificate revocation request corresponding to the JSON body from the '/certificate/revoke' endpoint

type RevokedCertificate

type RevokedCertificate struct {
	SerialNumber   string
	ReasonCode     int
	RevocationDate time.Time
}

RevokedCertificate -------------------------------------------------------- Structure used to read data from write data to the storage backend related to existing and new revoked certificates, and used in the '/certificate/revoke' endpoint

type SSHCertificate

type SSHCertificate struct {
	Certificate string `json:"certificate"`
}

SSHCertificate --------------------------

type SSHCertificateList

type SSHCertificateList struct {
	SSHCertificates []string `json:"sshCertificates"`
}

SSHCertificateList ----------------------

type SSHCriticalOptions

type SSHCriticalOptions struct {
	Option string `json:"option"`
	Value  string `json:"value"`
}

SSHCriticalOptions ----------------

type SSHRevokeRequest

type SSHRevokeRequest struct {
	SerialNumber string `json:"serialNumber"`
}

SSHRevokeRequest ------------------

type SSHSignRequest

type SSHSignRequest struct {
	TemplateName    string               `json:"templateName"`
	PublicKey       string               `json:"publicKey"`
	ValidPrincipals []string             `json:"users,omitempty"`
	Domains         []string             `json:"domains,omitempty"`
	TTL             uint64               `json:"ttl"`
	KeyID           string               `json:"keyId,omitempty"`
	CriticalOptions []SSHCriticalOptions `json:"criticalOptions,omitempty"`
	Extensions      []string             `json:"extensions,omitempty"`
}

SSHSignRequest -----------------

type SSHSignResponse

type SSHSignResponse struct {
	SerialNumber      string `json:"serialNumber"`
	SignedCertificate string `json:"signedCertificate"`
}

SSHSignResponse ----------------------

type SSHTemplate

type SSHTemplate struct {
	TemplateName             string               `json:"templateName"`
	CertType                 string               `json:"certType"`
	MaxTTL                   uint64               `json:"maxTTL"`
	AllowedHosts             []string             `json:"allowedHosts,omitempty"`
	AllowedPrincipals        []string             `json:"allowedPrincipals,omitempty"`
	PermittedCriticalOptions []SSHCriticalOptions `json:"permittedCriticalOptions,omitempty"`
	PermittedExtensions      []string             `json:"permittedExtensions,omitempty"`
}

SSHTemplate -------------------

type SignRequest

type SignRequest struct {
	CSR          string `json:"csr"`
	CommonName   string `json:"commonName"`
	TemplateName string `json:"templateName"`
	TTL          int64  `json:"ttl,omitempty"`
	ReturnFormat string `json:"returnFormat,omitempty"`
}

SignRequest ----------------------------------------------------------------- Structure that represents a certificate request corresponding to the JSON body from the '/certificate/sign' endpoint

type SubjectFields

type SubjectFields struct {
	Organization string `json:"organization,omitempty"`
	OrgUnit      string `json:"orgUnit,omitempty"`
	Country      string `json:"country,omitempty"`
	Locality     string `json:"locality,omitempty"`
	Province     string `json:"province,omitempty"`
	Address      string `json:"address,omitempty"`
	PostalCode   string `json:"postalCode,omitempty"`
}

SubjectFields ------------------------------------------------------------- A breakdown of subject fields corresponding to the pkix.Name object used by template and certificate objects

type Template

type Template struct {
	TemplateName       string        `json:"templateName"`
	KeyAlgo            string        `json:"keyAlgo"`
	KeyBits            string        `json:"keyBits"`
	MaxTTL             int64         `json:"maxTTL"`
	Subject            SubjectFields `json:"subject"`
	StoreCertificate   bool          `json:"storeCertificate"`
	KeyUsages          []string      `json:"keyUsages,omitempty"`
	ExtKeyUsages       []string      `json:"extKeyUsages,omitempty"`
	ValidateCNHostname bool          `json:"validateCNHostname,omitempty"`
	PermitLocalhostCN  bool          `json:"permitLocalhostCN,omitempty"`
	PermitWildcardCN   bool          `json:"permitWildcardCN,omitempty"`
	PermitRootDomainCN bool          `json:"permitRootDomain,omitempty"`
	PermitSubdomainCN  bool          `json:"permitSubdomainCN,omitempty"`
	AllowedCNDomains   []string      `json:"allowedCNDomains,omitempty"`
	PermDNSDomains     []string      `json:"permDNSDomains,omitempty"`
	ExclDNSDomains     []string      `json:"exclDNSDomains,omitempty"`
	PermIPRanges       []string      `json:"permIPRanges,omitempty"`
	ExclIPRanges       []string      `json:"exclIPRanges,omitempty"`
	PermEmails         []string      `json:"permEmails,omitempty"`
	ExclEmails         []string      `json:"exclEmails,omitempty"`
	PermURIDomains     []string      `json:"permURIDomains,omitempty"`
	ExclURIDomains     []string      `json:"exclURIDomains,omitempty"`
	PolicyIdentifiers  []string      `json:"policyIdentifiers,omitempty"`
}

Template -------------------------------------------------------------------- Structure that represents a certificate request template corresponding to the JSON body from the '/template/create' and '/template/manage' endpoints

type TemplateListResponse

type TemplateListResponse struct {
	Templates []string `json:"templates"`
}

TemplateListResponse -------------------------------------------------------- A structure that contains a JSON representation of template names returned as the response for endpoint '/templates'