certificate

Documentation

Index

• type Found
• type ParsedCertificates
  • func FindCertificates(ctx context.Context, imageTar io.Reader) (*ParsedCertificates, error)
• type Partial

Types

type Found

type Found struct {
	// Location is the filepath location where the certificate was found.
	Location string

	// Parser is the name of the parser which discovered the certificate.
	Parser string

	// Certificate is the parsed certificate. May be nil if the parser failed to
	// decode a found certificate.
	Certificate *x509.Certificate

	// Fingerprint is the SHA-1 fingerprint of the certificate.
	FingerprintSha1 [20]byte

	// Fingerprint is the SHA-256 fingerprint of the certificate.
	FingerprintSha256 [32]byte
}

Found is a single X.509 certificate which was found by a parser inside the given image.

type ParsedCertificates

type ParsedCertificates struct {
	// Found is a slice of full, valid certificates we've found in the given container image.
	Found []Found
	// Partials is a slice of any partial certificates we've found. This might be fragments of certificates in memory
	// or other anomalies.
	Partials []Partial
}

func FindCertificates

func FindCertificates(ctx context.Context, imageTar io.Reader) (*ParsedCertificates, error)

FindCertificates will scan a container image, given as a file handler to a TAR file, for certificates and return them.

type Partial

type Partial struct {
	// Location is the filepath location where the certificate was found.
	Location string

	// Parser is the name of the parser which discovered the certificate.
	Parser string

	// Reason is a human-readable explanation of the certificate, either describe
	// why it couldn't be parsed or a summary of the parsed certificate.
	Reason string
}

Partial is a "partial" certificate. Usually the result of parsing something that looks like a certificate but isn't valid, or some other anomaly. These are often worthy of further investigation, but aren't compatible with Paranoia's various certificate operations.