Documentation
¶
Index ¶
- type APICertificate
- type APICertificateSearch
- type AccessGroup
- type AuthorizationRequest
- type CA
- type CertTemplate
- type Client
- func (auth *Client) AccessGroup(accessGroupID string) (*AccessGroup, error)
- func (auth *Client) AccessGroups(offset, limit int, sortkey, sortdir string) ([]AccessGroup, error)
- func (auth *Client) CACertificate(caID, filename string) error
- func (auth *Client) CACertificates(accessGroupID string) ([]CA, error)
- func (auth *Client) CarrierConfigDownloadHandle(trustedClientID string) (*DownloadHandle, error)
- func (auth *Client) CertTemplates(service string) ([]CertTemplate, error)
- func (auth *Client) CertificateRevocationList(caID, filename string) error
- func (auth *Client) CreateAccessGroup(accessGroup *AccessGroup) (string, error)
- func (auth *Client) CreatePrincipalKey(groupID string) (*Principal, error)
- func (auth *Client) DeleteAccessGroup(accessGroupID string) error
- func (auth *Client) DeletePrincipalKey(groupID, keyID string) error
- func (auth *Client) DeployScriptDownloadHandle(trustedClientID string) (*DownloadHandle, error)
- func (auth *Client) DownloadCarrierConfig(trustedClientID, sessionID, filename string) error
- func (auth *Client) DownloadDeployScript(trustedClientID, sessionID, filename string) error
- func (auth *Client) DownloadExtenderCertificateCRL(filename, id string) error
- func (auth *Client) DownloadExtenderConfig(trustedClientID, sessionID, filename string) error
- func (auth *Client) DownloadPrincipalCommandScript(filename string) error
- func (auth *Client) DownloadWebProxyCertificateCRL(filename, trustedClientID string) error
- func (auth *Client) DownloadWebProxyConfig(trustedClientID, sessionID, filename string) error
- func (auth *Client) ExtenderCACertificate(id string) (*CA, error)
- func (auth *Client) ExtenderCACertificates(accessGroupID string) ([]CA, error)
- func (auth *Client) ExtenderConfigDownloadHandle(trustedClientID string) (*DownloadHandle, error)
- func (auth *Client) ExtenderTrustAnchor() (*TrustAnchor, error)
- func (auth *Client) ImportPrincipalKey(groupID string, key *PrincipalKeyImportRequest) (*Principal, error)
- func (auth *Client) Principal(groupID, keyID, filter string) (*Principal, error)
- func (auth *Client) Principals() ([]Principal, error)
- func (auth *Client) SSLTrustAnchor() (*TrustAnchor, error)
- func (auth *Client) SearchAccessGroup(offset, limit int, sortkey, sortdir string, search *SearchParams) ([]AccessGroup, error)
- func (auth *Client) SearchCert(offset, limit int, sortkey, sortdir string, cert *APICertificateSearch) ([]APICertificate, error)
- func (auth *Client) SignPrincipalKey(groupID, keyID string, credential *Credential) (*Signature, error)
- func (auth *Client) TargetHostCredentials(authorizer *AuthorizationRequest) (*Principal, error)
- func (auth *Client) UpdateAccessGroup(accessGroupID string, accessGroup *AccessGroup) error
- func (auth *Client) WebProxyCACertificate(trustedClientID string) (*CA, error)
- func (auth *Client) WebProxyCACertificates(accessGroupID string) ([]CA, error)
- func (auth *Client) WebProxySessionDownloadHandle(trustedClientID string) (*DownloadHandle, error)
- type Credential
- type DownloadHandle
- type Params
- type Principal
- type PrincipalKeyImportRequest
- type SearchParams
- type Signature
- type TrustAnchor
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APICertificate ¶
type APICertificate struct {
ID string `json:"id,omitempty"`
Type string `json:"type,omitempty"`
OwnerID string `json:"owner_id,omitempty"`
Revoked string `json:"revoked,omitempty"`
RevocationReason string `json:"revocation_reason,omitempty"`
Cert string `json:"cert,omitempty"`
Chain string `json:"chain,omitempty"`
}
APICertificate api certificate definition
type APICertificateSearch ¶
type APICertificateSearch struct {
ID string `json:"id,omitempty"`
Type string `json:"type,omitempty"`
KeyID string `json:"key_id,omitempty"`
OwnerID string `json:"owner_id,omitempty"`
Subject string `json:"subject,omitempty"`
Issuer string `json:"issuer,omitempty"`
NotBefore string `json:"not_before,omitempty"`
NotAfter string `json:"not_after,omitempty"`
IncludeRevoked bool `json:"include_revoked,omitempty"`
IncludeExpired bool `json:"include_expired,omitempty"`
}
APICertificateSearch api certificate search definition
type AccessGroup ¶
type AccessGroup struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Comment string `json:"comment,omitempty"`
CAID string `json:"ca_id,omitempty"`
Author string `json:"author,omitempty"`
Created string `json:"created,omitempty"`
Updated string `json:"updated,omitempty"`
UpdatedBy string `json:"updated_by,omitempty"`
Default bool `json:"default,omitempty"`
}
AccessGroup access group definition
type AuthorizationRequest ¶
type AuthorizationRequest struct {
PublicKey string `json:"public_key,omitempty"`
HostID string `json:"host_id,omitempty"`
Hostname string `json:"hostname,omitempty"`
Username string `json:"username,omitempty"`
Service string `json:"service,omitempty"`
RoleID string `json:"role_id,omitempty"`
}
AuthorizationRequest end user authorization request definition
type CA ¶
type CA struct {
ID string `json:"id"`
GroupID string `json:"group_id"`
Type string `json:"type"`
Size int `json:"size"`
PublicKey string `json:"public_key"`
X509 string `json:"x509_certificate"`
}
CA is root certificate representation
type CertTemplate ¶
type CertTemplate struct {
Name string `json:"name"`
Description string `json:"description"`
Service string `json:"service"`
Type string `json:"type"`
KeyID string `json:"key_id,omitempty"`
RsaSignatureTypes []string `json:"rsa_signature_types,omitempty"`
Principals []string `json:"principals,omitempty"`
Extensions []string `json:"extensions,omitempty"`
}
CertTemplate certification template definition
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a authorizer client instance.
func (*Client) AccessGroup ¶
func (auth *Client) AccessGroup(accessGroupID string) (*AccessGroup, error)
AccessGroup get access group
func (*Client) AccessGroups ¶
func (auth *Client) AccessGroups(offset, limit int, sortkey, sortdir string) ([]AccessGroup, error)
AccessGroups lists all access group
func (*Client) CACertificate ¶
CACertificate gets authorizer's root certificate
func (*Client) CACertificates ¶
CACertificates gets authorizer's root certificates
func (*Client) CarrierConfigDownloadHandle ¶
func (auth *Client) CarrierConfigDownloadHandle(trustedClientID string) (*DownloadHandle, error)
CarrierConfigDownloadHandle get a session id for a carrier config
func (*Client) CertTemplates ¶
func (auth *Client) CertTemplates(service string) ([]CertTemplate, error)
CertTemplates returns the certificate authentication templates for the service
func (*Client) CertificateRevocationList ¶
CertificateRevocationList gets authorizer CA's certificate revocation list.
func (*Client) CreateAccessGroup ¶
func (auth *Client) CreateAccessGroup(accessGroup *AccessGroup) (string, error)
CreateAccessGroup create a access group
func (*Client) CreatePrincipalKey ¶
CreatePrincipalKey create a principal key pair
func (*Client) DeleteAccessGroup ¶
DeleteAccessGroup delete a access group
func (*Client) DeletePrincipalKey ¶
DeletePrincipalKey delete the principal key by its group ID
func (*Client) DeployScriptDownloadHandle ¶
func (auth *Client) DeployScriptDownloadHandle(trustedClientID string) (*DownloadHandle, error)
DeployScriptDownloadHandle get a session id for a deployment script
func (*Client) DownloadCarrierConfig ¶
DownloadCarrierConfig gets a pre-configured carrier config
func (*Client) DownloadDeployScript ¶
DownloadDeployScript gets a pre-configured deployment script
func (*Client) DownloadExtenderCertificateCRL ¶
DownloadExtenderCertificateCRL gets authorizer CA's certificate revocation list
func (*Client) DownloadExtenderConfig ¶
DownloadExtenderConfig gets a pre-configured extender config
func (*Client) DownloadPrincipalCommandScript ¶
DownloadPrincipalCommandScript gets the principals_command.sh script
func (*Client) DownloadWebProxyCertificateCRL ¶
DownloadWebProxyCertificateCRL gets authorizer CA's certificate revocation list
func (*Client) DownloadWebProxyConfig ¶
DownloadWebProxyConfig gets a pre-configured web proxy config
func (*Client) ExtenderCACertificate ¶
ExtenderCACertificate gets authorizer's extender CA certificate
func (*Client) ExtenderCACertificates ¶
ExtenderCACertificates gets authorizer's extender CA certificates
func (*Client) ExtenderConfigDownloadHandle ¶
func (auth *Client) ExtenderConfigDownloadHandle(trustedClientID string) (*DownloadHandle, error)
ExtenderConfigDownloadHandle get a session id
func (*Client) ExtenderTrustAnchor ¶
func (auth *Client) ExtenderTrustAnchor() (*TrustAnchor, error)
ExtenderTrustAnchor returns the extender trust anchor (PrivX TLS CA certificate)
func (*Client) ImportPrincipalKey ¶
func (auth *Client) ImportPrincipalKey(groupID string, key *PrincipalKeyImportRequest) (*Principal, error)
ImportPrincipalKey mport a principal key pair
func (*Client) Principals ¶
Principals gets defined principals from the authorizer
func (*Client) SSLTrustAnchor ¶
func (auth *Client) SSLTrustAnchor() (*TrustAnchor, error)
SSLTrustAnchor returns the SSL trust anchor (PrivX TLS CA certificate)
func (*Client) SearchAccessGroup ¶
func (auth *Client) SearchAccessGroup(offset, limit int, sortkey, sortdir string, search *SearchParams) ([]AccessGroup, error)
SearchAccessGroup search for access groups
func (*Client) SearchCert ¶
func (auth *Client) SearchCert(offset, limit int, sortkey, sortdir string, cert *APICertificateSearch) ([]APICertificate, error)
SearchCert search for certificates
func (*Client) SignPrincipalKey ¶
func (auth *Client) SignPrincipalKey(groupID, keyID string, credential *Credential) (*Signature, error)
SignPrincipalKey sign a principal key and get a signature
func (*Client) TargetHostCredentials ¶
func (auth *Client) TargetHostCredentials(authorizer *AuthorizationRequest) (*Principal, error)
TargetHostCredentials get target host credentials for the user
func (*Client) UpdateAccessGroup ¶
func (auth *Client) UpdateAccessGroup(accessGroupID string, accessGroup *AccessGroup) error
UpdateAccessGroup update access group
func (*Client) WebProxyCACertificate ¶
WebProxyCACertificate gets authorizer's web proxy CA certificate
func (*Client) WebProxyCACertificates ¶
WebProxyCACertificates gets authorizer's web proxy CA certificates
func (*Client) WebProxySessionDownloadHandle ¶
func (auth *Client) WebProxySessionDownloadHandle(trustedClientID string) (*DownloadHandle, error)
WebProxySessionDownloadHandle get a session id for a web proxy config
type Credential ¶
Credential end user authentication credentials definition
type DownloadHandle ¶
type DownloadHandle struct {
SessionID string `json:"session_id"`
}
DownloadHandle download handle definition
type Params ¶
type Params struct {
ResponseType string `json:"response_type,omitempty"`
ClientID string `json:"client_id,omitempty"`
State string `json:"state,omitempty"`
RedirectURI string `json:"redirect_uri,omitempty"`
UserAgent string `json:"user_agent,omitempty"`
OidcID string `json:"oidc_id,omitempty"`
AccessGroupID string `json:"access_group_id,omitempty"`
KeyID string `json:"key_id,omitempty"`
Filter string `json:"filter,omitempty"`
Service string `json:"service,omitempty"`
Sortkey string `json:"sortkey,omitempty"`
Sortdir string `json:"sortdir,omitempty"`
Offset int `json:"offset,omitempty"`
Limit int `json:"limit,omitempty"`
}
Params query params definition
type Principal ¶
type Principal struct {
ID string `json:"id"`
GroupID string `json:"group_id,omitempty"`
Type string `json:"type,omitempty"`
Comment string `json:"comment,omitempty"`
PublicKey string `json:"public_key,omitempty"`
PublicKeyString string `json:"public_key_string,omitempty"`
Size int `json:"size,omitempty"`
}
Principal principal definition
type PrincipalKeyImportRequest ¶
type PrincipalKeyImportRequest struct {
Algorithm string `json:"algorithm"`
Data string `json:"data"`
}
PrincipalKeyImportRequest principal key import definition
type SearchParams ¶
type SearchParams struct {
Keywords string `json:"keywords,omitempty"`
}
SearchParams search params definition
type Signature ¶
type Signature struct {
Signature string `json:"signature"`
}
Signature signature definition
type TrustAnchor ¶
type TrustAnchor struct {
TrustAnchor string `json:"trust_anchor"`
TrustAnchorSHA1 string `json:"trust_anchor_sha1,omitempty"`
TrustAnchorSHA256 string `json:"trust_anchor_sha256,omitempty"`
}
TrustAnchor trust anchor definition