Xecrets.Sdk.Models.md

July 15, 2025 ยท View on GitHub

Xecrets.Sdk

Xecrets.Sdk.Models Namespace

The three classes Xecrets.Sdk.Models.XfOpCode, Xecrets.Sdk.Models.XfStatusCode and Xecrets.Sdk.Models.XfCliApi are imported from XecretsCli using the --cli-options-code-export argument and copy/pasted here to be available for use without needing an actual reference to the XecretsCli-assembly. If XfCliVersion is updated, then the corresponding code changes must be made to maintain compatibility and XfSdkVersion must be updated to reflect the updated compatibility.

Classes
XfCredentialsA cargo class carrying all the various possible credentials used for encryption or decryption. When it's not supported or doesn't make sense, only the first will be used.
XfEncryptedKeyPairAn encrypted key pair blob with some meta data.
XfEncryptedKeysExtra, possibly imported, encrypted private keys for a user.
XfEncryptedKeys.EncryptedKeyAn encrypted private key with additional metadata.
XfEncryptedKeys.EncryptedKeyPairA key pair with a public and an encrypted private key pem. Then encryption is done with a password using Xecrets Ez/AxCrypt and then the encrypted file is base64 encoded.
XfEncryptedKeys.EncryptedUserKeysA collection of encrypted private keys for a user, where a user is arbitrarily defined as an email address.
XfFilePairA plain text/cipher text file pair
XfFileResultInstatiate a new instance of XfFileResult
XfKeyPairA public key pair, including optional encryption password and meta data.
XfMessageLog output and progress from the command line tool.
Enums
XfEncryptedKeys.PrivateKeyPasswordRecords wether the private key password is known or unknown.