certificates

Documentation

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func ParseCSR(obj *CertificateSigningRequest) (*x509.CertificateRequest, error)
• func Resource(resource string) schema.GroupResource
• type CertificateSigningRequest
  • func (in *CertificateSigningRequest) DeepCopy() *CertificateSigningRequest
  • func (in *CertificateSigningRequest) DeepCopyInto(out *CertificateSigningRequest)
  • func (in *CertificateSigningRequest) DeepCopyObject() runtime.Object
• type CertificateSigningRequestCondition
  • func (in *CertificateSigningRequestCondition) DeepCopy() *CertificateSigningRequestCondition
  • func (in *CertificateSigningRequestCondition) DeepCopyInto(out *CertificateSigningRequestCondition)
• type CertificateSigningRequestList
  • func (in *CertificateSigningRequestList) DeepCopy() *CertificateSigningRequestList
  • func (in *CertificateSigningRequestList) DeepCopyInto(out *CertificateSigningRequestList)
  • func (in *CertificateSigningRequestList) DeepCopyObject() runtime.Object
• type CertificateSigningRequestSpec
  • func (in *CertificateSigningRequestSpec) DeepCopy() *CertificateSigningRequestSpec
  • func (in *CertificateSigningRequestSpec) DeepCopyInto(out *CertificateSigningRequestSpec)
• type CertificateSigningRequestStatus
  • func (in *CertificateSigningRequestStatus) DeepCopy() *CertificateSigningRequestStatus
  • func (in *CertificateSigningRequestStatus) DeepCopyInto(out *CertificateSigningRequestStatus)
• type ExtraValue
  • func (in ExtraValue) DeepCopy() ExtraValue
  • func (in ExtraValue) DeepCopyInto(out *ExtraValue)
• type KeyUsage
• type RequestConditionType

Constants

const GroupName = "certificates.k8s.io"

GroupName is the group name use in this package

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func ParseCSR

func ParseCSR(obj *CertificateSigningRequest) (*x509.CertificateRequest, error)

ParseCSR extracts the CSR from the API object and decodes it.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CertificateSigningRequest

type CertificateSigningRequest struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta

	// The certificate request itself and any additional information.
	// +optional
	Spec CertificateSigningRequestSpec

	// Derived information about the request.
	// +optional
	Status CertificateSigningRequestStatus
}

Describes a certificate signing request

func (*CertificateSigningRequest) DeepCopy

func (in *CertificateSigningRequest) DeepCopy() *CertificateSigningRequest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateSigningRequest.

func (*CertificateSigningRequest) DeepCopyInto

func (in *CertificateSigningRequest) DeepCopyInto(out *CertificateSigningRequest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CertificateSigningRequest) DeepCopyObject

func (in *CertificateSigningRequest) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CertificateSigningRequestCondition

type CertificateSigningRequestCondition struct {
	// request approval state, currently Approved or Denied.
	Type RequestConditionType
	// brief reason for the request state
	// +optional
	Reason string
	// human readable message with details about the request state
	// +optional
	Message string
	// timestamp for the last update to this condition
	// +optional
	LastUpdateTime metav1.Time
}

func (*CertificateSigningRequestCondition) DeepCopy

func (in *CertificateSigningRequestCondition) DeepCopy() *CertificateSigningRequestCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateSigningRequestCondition.

func (*CertificateSigningRequestCondition) DeepCopyInto

func (in *CertificateSigningRequestCondition) DeepCopyInto(out *CertificateSigningRequestCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CertificateSigningRequestList

type CertificateSigningRequestList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// +optional
	Items []CertificateSigningRequest
}

func (*CertificateSigningRequestList) DeepCopy

func (in *CertificateSigningRequestList) DeepCopy() *CertificateSigningRequestList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateSigningRequestList.

func (*CertificateSigningRequestList) DeepCopyInto

func (in *CertificateSigningRequestList) DeepCopyInto(out *CertificateSigningRequestList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CertificateSigningRequestList) DeepCopyObject

func (in *CertificateSigningRequestList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CertificateSigningRequestSpec

type CertificateSigningRequestSpec struct {
	// Base64-encoded PKCS#10 CSR data
	Request []byte

	// Requested signer for the request. It is a qualified name in the form:
	// `scope-hostname.io/name`.
	// Distribution of trust for signers happens out of band.
	// You can select on this field using `spec.signerName`.
	SignerName string

	// usages specifies a set of usage contexts the key will be
	// valid for.
	// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
	//      https://tools.ietf.org/html/rfc5280#section-4.2.1.12
	Usages []KeyUsage

	// Information about the requesting user.
	// See user.Info interface for details.
	// +optional
	Username string
	// UID information about the requesting user.
	// See user.Info interface for details.
	// +optional
	UID string
	// Group information about the requesting user.
	// See user.Info interface for details.
	// +optional
	Groups []string
	// Extra information about the requesting user.
	// See user.Info interface for details.
	// +optional
	Extra map[string]ExtraValue
}

This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.

func (*CertificateSigningRequestSpec) DeepCopy

func (in *CertificateSigningRequestSpec) DeepCopy() *CertificateSigningRequestSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateSigningRequestSpec.

func (*CertificateSigningRequestSpec) DeepCopyInto

func (in *CertificateSigningRequestSpec) DeepCopyInto(out *CertificateSigningRequestSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CertificateSigningRequestStatus

type CertificateSigningRequestStatus struct {
	// Conditions applied to the request, such as approval or denial.
	// +optional
	Conditions []CertificateSigningRequestCondition

	// If request was approved, the controller will place the issued certificate here.
	// +optional
	Certificate []byte
}

func (*CertificateSigningRequestStatus) DeepCopy

func (in *CertificateSigningRequestStatus) DeepCopy() *CertificateSigningRequestStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateSigningRequestStatus.

func (*CertificateSigningRequestStatus) DeepCopyInto

func (in *CertificateSigningRequestStatus) DeepCopyInto(out *CertificateSigningRequestStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ExtraValue

type ExtraValue []string

ExtraValue masks the value so protobuf can generate

func (ExtraValue) DeepCopy

func (in ExtraValue) DeepCopy() ExtraValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtraValue.

func (ExtraValue) DeepCopyInto

func (in ExtraValue) DeepCopyInto(out *ExtraValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KeyUsage

type KeyUsage string

KeyUsages specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3

https://tools.ietf.org/html/rfc5280#section-4.2.1.12

const (
	UsageSigning           KeyUsage = "signing"
	UsageDigitalSignature  KeyUsage = "digital signature"
	UsageContentCommitment KeyUsage = "content commitment"
	UsageKeyEncipherment   KeyUsage = "key encipherment"
	UsageKeyAgreement      KeyUsage = "key agreement"
	UsageDataEncipherment  KeyUsage = "data encipherment"
	UsageCertSign          KeyUsage = "cert sign"
	UsageCRLSign           KeyUsage = "crl sign"
	UsageEncipherOnly      KeyUsage = "encipher only"
	UsageDecipherOnly      KeyUsage = "decipher only"
	UsageAny               KeyUsage = "any"
	UsageServerAuth        KeyUsage = "server auth"
	UsageClientAuth        KeyUsage = "client auth"
	UsageCodeSigning       KeyUsage = "code signing"
	UsageEmailProtection   KeyUsage = "email protection"
	UsageSMIME             KeyUsage = "s/mime"
	UsageIPsecEndSystem    KeyUsage = "ipsec end system"
	UsageIPsecTunnel       KeyUsage = "ipsec tunnel"
	UsageIPsecUser         KeyUsage = "ipsec user"
	UsageTimestamping      KeyUsage = "timestamping"
	UsageOCSPSigning       KeyUsage = "ocsp signing"
	UsageMicrosoftSGC      KeyUsage = "microsoft sgc"
	UsageNetscapeSGC       KeyUsage = "netscape sgc"
)

type RequestConditionType

type RequestConditionType string

const (
	CertificateApproved RequestConditionType = "Approved"
	CertificateDenied   RequestConditionType = "Denied"
)

These are the possible conditions for a certificate request.