Documentation
¶
Index ¶
- func ConvertZipBytesToPem(dataByte []byte, rootFirst bool) (*certificate.PEMCollection, error)
- func Load32KeyByte(keyBytes []byte) (*[32]byte, error)
- func PolicyExist(policyName string, c *Connector) (bool, error)
- type ApplicationDetails
- type Certificate
- type CertificateSearchResponse
- type CertificateStatusErrorInformation
- type CertificateTemplates
- type Connector
- func (c *Connector) Authenticate(auth *endpoint.Authentication) (err error)
- func (c *Connector) CreateAPIUserAccount(userName string, password string) (int, *userDetails, error)
- func (c *Connector) CreateUserAccount(userAccount *userAccount) (int, *userDetails, error)
- func (c *Connector) GenerateRequest(config *endpoint.ZoneConfiguration, req *certificate.Request) (err error)
- func (c *Connector) GetPolicy(name string) (*policy.PolicySpecification, error)
- func (c *Connector) GetPolicyWithRegex(name string) (*policy.PolicySpecification, error)
- func (c *Connector) GetType() endpoint.ConnectorType
- func (c *Connector) GetZonesByParent(parent string) ([]string, error)
- func (c *Connector) ImportCertificate(req *certificate.ImportRequest) (*certificate.ImportResponse, error)
- func (c *Connector) IsCSRServiceGenerated(req *certificate.Request) (bool, error)
- func (c *Connector) ListCertificates(filter endpoint.Filter) ([]certificate.CertificateInfo, error)
- func (c *Connector) Ping() (err error)
- func (c *Connector) ReadPolicyConfiguration() (policy *endpoint.Policy, err error)
- func (c *Connector) ReadZoneConfiguration() (config *endpoint.ZoneConfiguration, err error)
- func (c *Connector) RenewCertificate(renewReq *certificate.RenewalRequest) (requestID string, err error)
- func (c *Connector) RequestCertificate(req *certificate.Request) (requestID string, err error)
- func (c *Connector) RequestSSHCertificate(req *certificate.SshCertRequest) (response *certificate.SshCertificateObject, err error)
- func (c *Connector) RetrieveAvailableSSHTemplates() (response []certificate.SshAvaliableTemplate, err error)
- func (c *Connector) RetrieveCertificate(req *certificate.Request) (certificates *certificate.PEMCollection, err error)
- func (c *Connector) RetrieveCertificateMetaData(dn string) (*certificate.CertificateMetaData, error)
- func (c *Connector) RetrieveSSHCertificate(req *certificate.SshCertRequest) (response *certificate.SshCertificateObject, err error)
- func (c *Connector) RetrieveSshConfig(ca *certificate.SshCaTemplateRequest) (*certificate.SshConfig, error)
- func (c *Connector) RetrieveSystemVersion() (response string, err error)
- func (c *Connector) RevokeCertificate(revReq *certificate.RevocationRequest) (err error)
- func (c *Connector) SearchCertificate(zone string, cn string, sans *certificate.Sans, certMinTimeLeft time.Duration) (certificateInfo *certificate.CertificateInfo, err error)
- func (c *Connector) SearchCertificates(req *certificate.SearchRequest) (*certificate.CertSearchResponse, error)
- func (c *Connector) SetHTTPClient(client *http.Client)
- func (c *Connector) SetPolicy(name string, ps *policy.PolicySpecification) (string, error)
- func (c *Connector) SetZone(z string)
- type CsrAttributes
- type EdgeEncryptionKey
- type Expression
- type Field
- type KeyStoreRequest
- type KeyTypeParameters
- type Operand
- type Operator
- type OwnerType
- type Paging
- type SearchRequest
- type SubjectAlternativeNamesByType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConvertZipBytesToPem ¶ added in v4.16.0
func ConvertZipBytesToPem(dataByte []byte, rootFirst bool) (*certificate.PEMCollection, error)
func Load32KeyByte ¶ added in v4.16.0
Types ¶
type ApplicationDetails ¶ added in v4.13.0
type ApplicationDetails struct {
ApplicationId string `json:"id,omitempty"`
CitAliasToIdMap map[string]string `json:"certificateIssuingTemplateAliasIdMap,omitempty"`
CompanyId string `json:"companyId,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
OwnerIdType []policy.OwnerIdType `json:"ownerIdsAndTypes,omitempty"`
InternalFqDns []string `json:"internalFqDns,omitempty"`
ExternalIpRanges []string `json:"externalIpRanges,omitempty"`
InternalIpRanges []string `json:"internalIpRanges,omitempty"`
InternalPorts []string `json:"internalPorts,omitempty"`
FullyQualifiedDomainNames []string `json:"fullyQualifiedDomainNames,omitempty"`
IpRanges []string `json:"ipRanges,omitempty"`
Ports []string `json:"ports,omitempty"`
FqDns []string `json:"fqDns,omitempty"`
}
type Certificate ¶
type Certificate struct {
Id string `json:"id"`
ManagedCertificateId string `json:"managedCertificateId"`
CertificateRequestId string `json:"certificateRequestId"`
SubjectCN []string `json:"subjectCN"`
SubjectAlternativeNamesByType map[string][]string `json:"subjectAlternativeNamesByType"`
SerialNumber string `json:"serialNumber"`
Fingerprint string `json:"fingerprint"`
ValidityStart string `json:"validityStart"`
ValidityEnd string `json:"validityEnd"`
ApplicationIds []string `json:"applicationIds"`
}
func (Certificate) ToCertificateInfo ¶
func (c Certificate) ToCertificateInfo() certificate.CertificateInfo
type CertificateSearchResponse ¶
type CertificateSearchResponse struct {
Count int `json:"count"`
Certificates []Certificate `json:"certificates"`
}
func ParseCertificateSearchResponse ¶
func ParseCertificateSearchResponse(httpStatusCode int, body []byte) (searchResult *CertificateSearchResponse, err error)
type CertificateTemplates ¶ added in v4.14.0
type CertificateTemplates struct {
CertificateTemplates []certificateTemplate `json:"certificateIssuingTemplates"`
}
type Connector ¶
type Connector struct {
// contains filtered or unexported fields
}
Connector contains the base data needed to communicate with the Venafi Cloud servers
func NewConnector ¶
NewConnector creates a new Venafi Cloud Connector object used to communicate with Venafi Cloud
func (*Connector) Authenticate ¶
func (c *Connector) Authenticate(auth *endpoint.Authentication) (err error)
Authenticate authenticates the user with Venafi Cloud using the provided API Key
func (*Connector) CreateAPIUserAccount ¶ added in v4.20.0
func (*Connector) CreateUserAccount ¶ added in v4.20.0
func (*Connector) GenerateRequest ¶
func (c *Connector) GenerateRequest(config *endpoint.ZoneConfiguration, req *certificate.Request) (err error)
GenerateRequest generates a CertificateRequest based on the zone configuration, and returns the request along with the private key.
func (*Connector) GetPolicy ¶ added in v4.14.0
func (c *Connector) GetPolicy(name string) (*policy.PolicySpecification, error)
func (*Connector) GetPolicyWithRegex ¶ added in v4.16.0
func (c *Connector) GetPolicyWithRegex(name string) (*policy.PolicySpecification, error)
func (*Connector) GetType ¶
func (c *Connector) GetType() endpoint.ConnectorType
func (*Connector) GetZonesByParent ¶ added in v4.20.0
GetZonesByParent returns a list of valid zones for a VaaS application specified by parent
func (*Connector) ImportCertificate ¶
func (c *Connector) ImportCertificate(req *certificate.ImportRequest) (*certificate.ImportResponse, error)
func (*Connector) IsCSRServiceGenerated ¶ added in v4.16.0
func (c *Connector) IsCSRServiceGenerated(req *certificate.Request) (bool, error)
func (*Connector) ListCertificates ¶
func (c *Connector) ListCertificates(filter endpoint.Filter) ([]certificate.CertificateInfo, error)
func (*Connector) Ping ¶
Ping attempts to connect to the Venafi Cloud API and returns an errror if it cannot
func (*Connector) ReadPolicyConfiguration ¶
func (*Connector) ReadZoneConfiguration ¶
func (c *Connector) ReadZoneConfiguration() (config *endpoint.ZoneConfiguration, err error)
ReadZoneConfiguration reads the Zone information needed for generating and requesting a certificate from Venafi Cloud
func (*Connector) RenewCertificate ¶
func (c *Connector) RenewCertificate(renewReq *certificate.RenewalRequest) (requestID string, err error)
RenewCertificate attempts to renew the certificate
func (*Connector) RequestCertificate ¶
func (c *Connector) RequestCertificate(req *certificate.Request) (requestID string, err error)
RequestCertificate submits the CSR to the Venafi Cloud API for processing
func (*Connector) RequestSSHCertificate ¶ added in v4.15.0
func (c *Connector) RequestSSHCertificate(req *certificate.SshCertRequest) (response *certificate.SshCertificateObject, err error)
func (*Connector) RetrieveAvailableSSHTemplates ¶ added in v4.17.1
func (c *Connector) RetrieveAvailableSSHTemplates() (response []certificate.SshAvaliableTemplate, err error)
func (*Connector) RetrieveCertificate ¶
func (c *Connector) RetrieveCertificate(req *certificate.Request) (certificates *certificate.PEMCollection, err error)
RetrieveCertificate retrieves the certificate for the specified ID
func (*Connector) RetrieveCertificateMetaData ¶ added in v4.17.1
func (c *Connector) RetrieveCertificateMetaData(dn string) (*certificate.CertificateMetaData, error)
func (*Connector) RetrieveSSHCertificate ¶ added in v4.15.0
func (c *Connector) RetrieveSSHCertificate(req *certificate.SshCertRequest) (response *certificate.SshCertificateObject, err error)
func (*Connector) RetrieveSshConfig ¶ added in v4.15.2
func (c *Connector) RetrieveSshConfig(ca *certificate.SshCaTemplateRequest) (*certificate.SshConfig, error)
func (*Connector) RetrieveSystemVersion ¶ added in v4.22.1
func (*Connector) RevokeCertificate ¶
func (c *Connector) RevokeCertificate(revReq *certificate.RevocationRequest) (err error)
RevokeCertificate attempts to revoke the certificate
func (*Connector) SearchCertificate ¶ added in v4.22.0
func (c *Connector) SearchCertificate(zone string, cn string, sans *certificate.Sans, certMinTimeLeft time.Duration) (certificateInfo *certificate.CertificateInfo, err error)
func (*Connector) SearchCertificates ¶ added in v4.17.0
func (c *Connector) SearchCertificates(req *certificate.SearchRequest) (*certificate.CertSearchResponse, error)
func (*Connector) SetHTTPClient ¶
type CsrAttributes ¶ added in v4.16.0
type CsrAttributes struct {
CommonName *string `json:"commonName,omitempty"`
Organization *string `json:"organization,omitempty"`
OrganizationalUnits []string `json:"organizationalUnits,omitempty"`
Locality *string `json:"locality,omitempty"`
State *string `json:"state,omitempty"`
Country *string `json:"country,omitempty"`
SubjectAlternativeNamesByType *SubjectAlternativeNamesByType `json:"subjectAlternativeNamesByType,omitempty"`
KeyTypeParameters *KeyTypeParameters `json:"keyTypeParameters,omitempty"`
}
type EdgeEncryptionKey ¶ added in v4.16.0
type EdgeEncryptionKey struct {
Key string `json:"key,omitempty"`
}
type Expression ¶
type KeyStoreRequest ¶ added in v4.16.0
type KeyTypeParameters ¶ added in v4.18.0
type SearchRequest ¶
type SearchRequest struct {
Expression *Expression `json:"expression"`
Ordering *interface{} `json:"ordering,omitempty"`
Paging *Paging `json:"paging,omitempty"`
}