credentials

Documentation

Overview

CredHub credential types

Index

• type Base
• type BulkRegenerateResults
• type Certificate
• type CertificateMetadata
• type CertificateMetadataVersion
• type Credential
  • func (c Credential) MarshalJSON() ([]byte, error)
  • func (c Credential) MarshalYAML() (interface{}, error)
• type FindResults
• type JSON
• type Metadata
• type Password
• type Path
• type Paths
• type RSA
• type SSH
• type User
• type Value

Types

type Base

type Base struct {
	Id                 string   `json:"id" yaml:"id"`
	Name               string   `json:"name" yaml:"name"`
	Type               string   `json:"type" yaml:"type"`
	Metadata           Metadata `json:"metadata" yaml:"metadata"`
	VersionCreatedAt   string   `json:"version_created_at" yaml:"version_created_at"`
	DurationOverridden bool     `json:"duration_overridden,omitempty" yaml:"duration_overridden,omitempty"`
	DurationUsed       int      `json:"duration_used,omitempty" yaml:"duration_used,omitempty"`
}

Base fields of a credential

type BulkRegenerateResults

type BulkRegenerateResults struct {
	Certificates []string `json:"regenerated_credentials" yaml:"regenerated_credentials"`
}

Type needed for Bulk Regenerate functionality

type Certificate

type Certificate struct {
	Base  `yaml:",inline"`
	Value values.Certificate `json:"value"`
}

A Certificate type credential

type CertificateMetadata

type CertificateMetadata struct {
	Id       string                       `json:"id" yaml:"id"`
	Name     string                       `json:"name" yaml:"name"`
	SignedBy string                       `json:"signed_by" yaml:"signed_by"`
	Signs    []string                     `json:"signs" yaml:"signs"`
	Versions []CertificateMetadataVersion `json:"versions" yaml:"versions"`
}

type CertificateMetadataVersion

type CertificateMetadataVersion struct {
	Id                   string `json:"id" yaml:"id"`
	ExpiryDate           string `json:"expiry_date" yaml:"expiry_date"`
	Transitional         bool   `json:"transitional" yaml:"transitional"`
	CertificateAuthority bool   `json:"certificate_authority" yaml:"certificate_authority"`
	SelfSigned           bool   `json:"self_signed" yaml:"self_signed"`
}

type Credential

type Credential struct {
	Base  `yaml:",inline"`
	Value interface{} `json:"value"`
}

A generic credential

Used when the Type of the credential is not known ahead of time.

Value will be as unmarshalled by https://golang.org/pkg/encoding/json/#Unmarshal

func (Credential) MarshalJSON

func (c Credential) MarshalJSON() ([]byte, error)

func (Credential) MarshalYAML

func (c Credential) MarshalYAML() (interface{}, error)

type FindResults

type FindResults struct {
	Credentials []struct {
		Name             string `json:"name" yaml:"name"`
		VersionCreatedAt string `json:"version_created_at" yaml:"version_created_at"`
	} `json:"credentials" yaml:"credentials"`
}

Types needed for Find functionality

type JSON

type JSON struct {
	Base  `yaml:",inline"`
	Value values.JSON `json:"value"`
}

A JSON type credential

type Metadata

type Metadata map[string]interface{}

Arbitrary metadata for credentials

type Password

type Password struct {
	Base  `yaml:",inline"`
	Value values.Password `json:"value"`
}

A Password type credential

type Path

type Path struct {
	Path string `json:"path" yaml:"path"`
}

type Paths

type Paths struct {
	Paths []Path `json:"paths" yaml:"paths"`
}

type RSA

type RSA struct {
	Base  `yaml:",inline"`
	Value values.RSA `json:"value"`
}

An RSA type credential

type SSH

type SSH struct {
	Base  `yaml:",inline"`
	Value struct {
		values.SSH           `yaml:",inline"`
		PublicKeyFingerprint string `json:"public_key_fingerprint" yaml:"public_key_fingerprint"`
	} `json:"value"`
}

An SSH type credential

type User

type User struct {
	Base  `yaml:",inline"`
	Value struct {
		values.User  `yaml:",inline"`
		PasswordHash string `json:"password_hash" yaml:"password_hash"`
	} `json:"value"`
}

A User type credential

type Value

type Value struct {
	Base  `yaml:",inline"`
	Value values.Value `json:"value"`
}

A Value type credential