cryptkey

package

v1.3.1 Latest Latest Go to latest Published: Apr 24, 2024 License: BSD-3-Clause Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/apptainer/apptainer

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func EncryptKey(k KeyInfo, plaintext []byte) ([]byte, error)
func GenerateRSAKey(keySize int) (*rsa.PrivateKey, error)
func LoadPEMPrivateKey(k KeyInfo) (*rsa.PrivateKey, error)
func LoadPEMPrivateKeyEnvVar(en string) (*rsa.PrivateKey, error)
func LoadPEMPrivateKeyFile(fn string) (*rsa.PrivateKey, error)
func LoadPEMPublicKey(k KeyInfo) (*rsa.PublicKey, error)
func LoadPEMPublicKeyEnvVar(en string) (*rsa.PublicKey, error)
func LoadPEMPublicKeyFile(fn string) (*rsa.PublicKey, error)
func NewPlaintextKey(k KeyInfo) ([]byte, error)
func PlaintextKey(k KeyInfo, image string) ([]byte, error)
func SavePrivatePEM(fileName string, key *rsa.PrivateKey) error
func SavePublicPEM(fileName string, key *rsa.PrivateKey) error
type KeyInfo

Constants ¶

View Source

const (
	// Unknown indicates the key material format is not known.
	Unknown = iota
	// Passphrase indicates the key material is formatted as a passphrase.
	Passphrase
	// PEM indicates the key material is formatted as a PEM file.
	PEM
	// ENV indicates PEM content saved in an environment variable.
	ENV
	// hash size for encryption (Bytes)
	Hash = 32
)

View Source

const (
	// DefaultKeySize is the default size of the key that is used when a
	// size is not explicitly specified
	DefaultKeySize = 2048
)

Variables ¶

View Source

var (
	// ErrEncryptedKeyNotFound indicates the encrypted key is not found.
	ErrEncryptedKeyNotFound = errors.New("encrypted key not found")
	// ErrUnsupportedKeyURI indicates the key URI is not supported.
	ErrUnsupportedKeyURI = errors.New("unsupported key URI")
	// ErrNoEncryptedKeyData indicates there is no encrypted key data.
	ErrNoEncryptedKeyData = errors.New("no encrypted key data")
	// ErrNoPEMData indicates there is no PEM data.
	ErrNoPEMData = errors.New("no PEM data")
)

Functions ¶

func EncryptKey ¶

func EncryptKey(k KeyInfo, plaintext []byte) ([]byte, error)

func GenerateRSAKey ¶

func GenerateRSAKey(keySize int) (*rsa.PrivateKey, error)

GenerateRSAKey creates a new RSA key of length keySize.

func LoadPEMPrivateKey ¶

func LoadPEMPrivateKey(k KeyInfo) (*rsa.PrivateKey, error)

func LoadPEMPrivateKeyEnvVar ¶ added in v1.3.0

func LoadPEMPrivateKeyEnvVar(en string) (*rsa.PrivateKey, error)

func LoadPEMPrivateKeyFile ¶ added in v1.3.0

func LoadPEMPrivateKeyFile(fn string) (*rsa.PrivateKey, error)

func LoadPEMPublicKey ¶

func LoadPEMPublicKey(k KeyInfo) (*rsa.PublicKey, error)

func LoadPEMPublicKeyEnvVar ¶ added in v1.3.0

func LoadPEMPublicKeyEnvVar(en string) (*rsa.PublicKey, error)

func LoadPEMPublicKeyFile ¶ added in v1.3.0

func LoadPEMPublicKeyFile(fn string) (*rsa.PublicKey, error)

func NewPlaintextKey ¶

func NewPlaintextKey(k KeyInfo) ([]byte, error)

func PlaintextKey ¶

func PlaintextKey(k KeyInfo, image string) ([]byte, error)

func SavePrivatePEM ¶

func SavePrivatePEM(fileName string, key *rsa.PrivateKey) error

SavePrivatePEM saves a private PEM key into a file.

func SavePublicPEM ¶

func SavePublicPEM(fileName string, key *rsa.PrivateKey) error

SavePublicPEM saves a public PEM key into a file.

Types ¶

type KeyInfo ¶

type KeyInfo struct {
	Format   int
	Material string
	Path     string
}

KeyInfo contains information for passing around or extracting a passphrase for an encrypted container

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL