Xecrets.Sdk.Models.XfCredentials.md
May 26, 2026 · View on GitHub
Xecrets.Sdk
Xecrets.Sdk.Models
XfCredentials Class
A 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.
public class XfCredentials
Inheritance System.Object → XfCredentials
Properties
XfCredentials.KeyPairFullNames Property
An enumeration of full path names to key pair PEM files
public System.Collections.Generic.IEnumerable<string> KeyPairFullNames { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>
XfCredentials.Passwords Property
An enumeration of passwords
public System.Collections.Generic.IEnumerable<string> Passwords { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>
XfCredentials.PrivateKeyFullNames Property
An enumeration of full path names to encrypted private key files in the XfEncryptedKeys format
public System.Collections.Generic.IEnumerable<string> PrivateKeyFullNames { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>
XfCredentials.PublicKeyEmails Property
An enumeration of email monikers referring to public keys
public System.Collections.Generic.IEnumerable<string> PublicKeyEmails { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>
XfCredentials.PublicKeyFullNames Property
An enumeration of full path names to public key PEM files
public System.Collections.Generic.IEnumerable<string> PublicKeyFullNames { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>
Methods
XfCredentials.AddCredentials(XfCredentials) Method
Add all the credentials from another XfCredentials object.
public void AddCredentials(Xecrets.Sdk.Models.XfCredentials credentials);
Parameters
credentials XfCredentials
The credentials to add.
XfCredentials.AddKeyPairFullNames(IEnumerable) Method
Add zero or more full path names to key pairs to add to the collection of credentials.
public void AddKeyPairFullNames(System.Collections.Generic.IEnumerable<string> keyPairFullNames);
Parameters
keyPairFullNames System.Collections.Generic.IEnumerable<System.String>
An enumeration of full path names to files containing key pairs.
XfCredentials.AddPasswords(IEnumerable) Method
Add zero or more passwords to add to the collection of credentials.
public void AddPasswords(System.Collections.Generic.IEnumerable<string> passwords);
Parameters
passwords System.Collections.Generic.IEnumerable<System.String>
An enumeration of passwords to add.
XfCredentials.AddPrivateKeysFullNames(IEnumerable) Method
Add zero or more full path names to encrypted private keys to add to the collection of credentials.
public void AddPrivateKeysFullNames(System.Collections.Generic.IEnumerable<string> encryptedPrivateKeyFullNames);
Parameters
encryptedPrivateKeyFullNames System.Collections.Generic.IEnumerable<System.String>
An enumeration of full path names to files containing encrypted private keys.
XfCredentials.AddPublicKeyEmails(IEnumerable) Method
Add zero or more email monikers to add to the collection of credentials.
public void AddPublicKeyEmails(System.Collections.Generic.IEnumerable<string> publicKeyEmails);
Parameters
publicKeyEmails System.Collections.Generic.IEnumerable<System.String>
An enumeration of email monikers referring to public keys.
XfCredentials.AddPublicKeyFullNames(IEnumerable) Method
Add zero or more full path names to public keys to add to the collection of credentials.
public void AddPublicKeyFullNames(System.Collections.Generic.IEnumerable<string> publicKeyFullNames);
Parameters
publicKeyFullNames System.Collections.Generic.IEnumerable<System.String>
An enumeration of full path names to files containing public keys.