package
0.0.0-20240917120716-8843776e9f3a
Repository: https://github.com/cossacklabs/acra.git
Documentation: pkg.go.dev

# Functions

DestroyKey destroys data of the requsted key.
DestroyKeyCommand implements the "destroy" command.
ExportKeysCommand implements the "export" command.
ExtractClientID extract clientID based on ExtractClientIDParams.
GenerateAcraKeys generates Acra CE keys as specified by the parameters.
GenerateMasterKey generates master key into output file.
ImportKeysCommand implements the "import" command.
IsKeyStoreV1 checks if the directory contains a keystore version 1 from KeyStoreParameters.
IsKeyStoreV2 checks if the directory contains a keystore version 2 from KeyStoreParameters.
ListKeysCommand implements the "list" command.
MigrateV1toV2 transfers keys from keystore v1 to v2.
OpenKeyStoreForExport opens a keystore suitable for export operations.
OpenKeyStoreForImport opens a keystore suitable for import operations.
OpenKeyStoreForReading opens a keystore suitable for reading keys.
OpenKeyStoreForWriting opens a keystore suitable for modifications.
ParseKeyKind parses key ID of form "client/Alice/storage" and returns key kind and possible ID.
ParseParameters parses command-line parameters and returns the selected subcommand.
PrintKeys prints key list prettily into the given writer.
ReadKeyBytes returns plaintext bytes of the requsted key.
ValidateClientID checks that client ID is specified correctly.
WriteExportedData saves exported key data and ephemeral keys into designated files.

# Constants

Sub-command names:.
Sub-command names:.
Sub-command names:.
Sub-command names:.
Sub-command names:.
Sub-command names:.
Sub-command names:.
Sub-command names:.
DefaultKeyDirectory is the default path to key directory.
Environment variables from which master keys are read.
ExportKeyPerm is file permissions required for exported key data.
Generate only the explicitly requested keys.
Generate default set of keys regardless of the requested keys.
Automatically generate default set of keys if no keys were requested and the keystore is empty.
ServiceName constant for logging and configuration parsing.
Environment variables from which master keys are read.

# Variables

DefaultConfigPath is the default path to service configuration file.
Key parameter errors:.
Key parameter errors:.
Key parameter errors:.
Key export errors:.
ErrInvalidIndex error represent invalid index for --index flag.
Key parameter errors:.
Command-line errors for "acra-keys migrate":.
Command-line errors for "acra-keys migrate":.
Command-line parsing errors:.
Command-line parsing errors:.
Key parameter errors:.
Key generation errors:.
Command-line parsing errors:.
Key parameter errors:.
Command-line parsing errors:.
KeyStoreFactory should return one of those errors when it is not able to construct requested keystore.
Command-line parsing errors:.
Key parameter errors:.
Key generation errors:.
Command-line parsing errors:.
SupportedDestroyKeyKinds is a list of keys supported by `destroy-key` subcommand.
SupportedReadKeyKinds is a list of keys supported by `read-key` subcommand.

# Structs

CommonExportImportParameters are common parameters of "acra-keys export" and "acra-keys import" subcommand.
CommonExtractClientIDParameters is a mix-in of command line parameters for extracting clientID from TLS certificate.
CommonKeyListingParameters is a mix-in of command line parameters for keystore listing.
CommonKeyStoreParameters is a mix-in of command line parameters for keystore construction.
DestroyKeySubcommand is the "acra-keys destroy" subcommand.
ExportKeysSubcommand is the "acra-keys export" subcommand.
ExtractClientIDSubcommand is the "acra-keys extract-client-id" subcommand.
GenerateKeySubcommand is the "acra-keys generate" subcommand.
ImportKeysSubcommand is the "acra-keys import" subcommand.
ListKeySubcommand is the "acra-keys list" subcommand.
MigrateKeysSubcommand is the "acra-keys migrate" subcommand.
ReadKeySubcommand is the "acra-keys read" subcommand.

# Interfaces

DestroyKeyParams are parameters of "acra-keys destroy" subcommand.
ExportImportCommonParams are common parameters of "acra-keys export" and "acra-keys import" subcommand.
ExportKeysParams are parameters of "acra-keys export" subcommand.
ExtractClientIDParams are parameters of "acra-keys extract-client-id" subcommand.
GenerateKeyParams are parameters of "acra-keys generate" subcommand.
ImportKeysParams are parameters of "acra-keys import" subcommand.
KeyStoreParameters are parameters for DefaultKeyStoreFactory.
ListKeysParams ara parameters of "acra-keys list" subcommand.
MigrateKeysParams ara parameters of "acra-keys migrate" subcommand.
ReadKeyParams are parameters of "acra-keys read" subcommand.
Subcommand is "acra-keys" subcommand, like "acra-keys export".

# Type aliases

DefaultKeyAction defines how GenerateAcraKeys() handles the default key set.