✨ Add --load-private-keys option #95

Author: xecrets

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "8.0.403",
+    "version": "8.0.404",
     "rollForward": "disable",
     "allowPrerelease": false
   }

sdk-docs/Xecrets.Sdk.Abstractions.md

@@ -408,6 +408,33 @@ string[] StartMe(string fileNameWithoutExtension);
 
 [System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException')
 
+<a name='Xecrets.Sdk.Abstractions.IXfApi.UpdatePrivateKeysAsync(Xecrets.Sdk.Models.XfCredentials,string)'></a>
+
+## IXfApi.UpdatePrivateKeysAsync(XfCredentials, string) Method
+
+Load private keys for decryption, returning an updated version with the same keys.
+
+```csharp
+System.Threading.Tasks.Task<string> UpdatePrivateKeysAsync(Xecrets.Sdk.Models.XfCredentials credentials, string json);
+```
+#### Parameters
+
+<a name='Xecrets.Sdk.Abstractions.IXfApi.UpdatePrivateKeysAsync(Xecrets.Sdk.Models.XfCredentials,string).credentials'></a>
+
+`credentials` [XfCredentials](Xecrets.Sdk.Models.XfCredentials.md 'Xecrets.Sdk.Models.XfCredentials')
+
+One or more passwords to decrypt the private keys with.
+
+<a name='Xecrets.Sdk.Abstractions.IXfApi.UpdatePrivateKeysAsync(Xecrets.Sdk.Models.XfCredentials,string).json'></a>
+
+`json` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+A json serialized instance with private keys.
+
+#### Returns
+[System.Threading.Tasks.Task&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')  
+The updated encrypted keys json.
+
 <a name='Xecrets.Sdk.Abstractions.IXfApi.WipeFilesAsync(System.Collections.Generic.IEnumerable_string_,System.Action_Xecrets.Sdk.Cli.CliMessage_)'></a>
 
 ## IXfApi.WipeFilesAsync(IEnumerable<string>, Action<CliMessage>) Method
@@ -449,31 +476,24 @@ Derived
 &#8627; [XfApiFactory](Xecrets.Sdk.XfApiFactory.md 'Xecrets.Sdk.XfApiFactory')
 ### Methods
 
-<a name='Xecrets.Sdk.Abstractions.IXfApiFactory.Create()'></a>
+<a name='Xecrets.Sdk.Abstractions.IXfApiFactory.Create(System.Nullable_bool_,System.Threading.CancellationToken)'></a>
 
-## IXfApiFactory.Create() Method
+## IXfApiFactory.Create(Nullable<bool>, CancellationToken) Method
 
-Create an [IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi 'Xecrets.Sdk.Abstractions.IXfApi') instance without cancellation."/>
+Create an [IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi 'Xecrets.Sdk.Abstractions.IXfApi') instance.
 
 ```csharp
-Xecrets.Sdk.Abstractions.IXfApi Create();
+Xecrets.Sdk.Abstractions.IXfApi Create(System.Nullable<bool> debugOverride, System.Threading.CancellationToken ct);
 ```
+#### Parameters
 
-#### Returns
-[IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi 'Xecrets.Sdk.Abstractions.IXfApi')
-
-<a name='Xecrets.Sdk.Abstractions.IXfApiFactory.Create(System.Threading.CancellationToken)'></a>
-
-## IXfApiFactory.Create(CancellationToken) Method
+<a name='Xecrets.Sdk.Abstractions.IXfApiFactory.Create(System.Nullable_bool_,System.Threading.CancellationToken).debugOverride'></a>
 
-Create an [IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi 'Xecrets.Sdk.Abstractions.IXfApi') instance.
+`debugOverride` [System.Nullable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
 
-```csharp
-Xecrets.Sdk.Abstractions.IXfApi Create(System.Threading.CancellationToken ct);
-```
-#### Parameters
+Override the global debug cli flag if non-null.
 
-<a name='Xecrets.Sdk.Abstractions.IXfApiFactory.Create(System.Threading.CancellationToken).ct'></a>
+<a name='Xecrets.Sdk.Abstractions.IXfApiFactory.Create(System.Nullable_bool_,System.Threading.CancellationToken).ct'></a>
 
 `ct` [System.Threading.CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.CancellationToken 'System.Threading.CancellationToken')
 

sdk-docs/Xecrets.Sdk.Cli.CliMessage.md

@@ -94,7 +94,7 @@ public string? Message { get; set; }
 
 ## CliMessage.OpCode Property
 
-The current [Xecrets.Cli.Public.XfOpCode](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Cli.Public.XfOpCode 'Xecrets.Cli.Public.XfOpCode') for this response.
+The current [Xecrets.Sdk.Cli.XfOpCode](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Sdk.Cli.XfOpCode 'Xecrets.Sdk.Cli.XfOpCode') for this response.
 
 ```csharp
 public int OpCode { get; set; }
@@ -107,7 +107,7 @@ public int OpCode { get; set; }
 
 ## CliMessage.OpCodeName Property
 
-The name of the [Xecrets.Cli.Public.XfOpCode](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Cli.Public.XfOpCode 'Xecrets.Cli.Public.XfOpCode') for this response.
+The name of the [Xecrets.Sdk.Cli.XfOpCode](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Sdk.Cli.XfOpCode 'Xecrets.Sdk.Cli.XfOpCode') for this response.
 
 ```csharp
 public string? OpCodeName { get; set; }

sdk-docs/Xecrets.Sdk.Cli.md

@@ -2,6 +2,12 @@
 
 ## Xecrets.Sdk.Cli Namespace
 
+The three classes [Xecrets.Sdk.Cli.XfOpCode](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Sdk.Cli.XfOpCode 'Xecrets.Sdk.Cli.XfOpCode'), [Xecrets.Sdk.Cli.XfStatusCode](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Sdk.Cli.XfStatusCode 'Xecrets.Sdk.Cli.XfStatusCode') and [Xecrets.Sdk.Cli.XfCliApi](https://docs.microsoft.com/en-us/dotnet/api/Xecrets.Sdk.Cli.XfCliApi 'Xecrets.Sdk.Cli.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](Xecrets.Sdk.XfSdkVersion.md 'Xecrets.Sdk.XfSdkVersion')  
+must be updated to reflect the updated compatibility.
+
 | Classes | |
 | :--- | :--- |
 | [CliMessage](Xecrets.Sdk.Cli.CliMessage.md 'Xecrets.Sdk.Cli.CliMessage') | Log output and progress from the command line tool. |

sdk-docs/Xecrets.Sdk.Models.XfCredentials.md

@@ -39,6 +39,19 @@ public System.Collections.Generic.IEnumerable<string> Passwords { get; }
 #### Property Value
 [System.Collections.Generic.IEnumerable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')
 
+<a name='Xecrets.Sdk.Models.XfCredentials.PrivateKeyFullNames'></a>
+
+## XfCredentials.PrivateKeyFullNames Property
+
+An enumeration of full path names to encrypted private key files in the XfEncryptedKeys format
+
+```csharp
+public System.Collections.Generic.IEnumerable<string> PrivateKeyFullNames { get; }
+```
+
+#### Property Value
+[System.Collections.Generic.IEnumerable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')
+
 <a name='Xecrets.Sdk.Models.XfCredentials.PublicKeyEmails'></a>
 
 ## XfCredentials.PublicKeyEmails Property
@@ -117,6 +130,24 @@ public void AddPasswords(System.Collections.Generic.IEnumerable<string> password
 
 An enumeration of passwords to add.
 
+<a name='Xecrets.Sdk.Models.XfCredentials.AddPrivateKeysFullNames(System.Collections.Generic.IEnumerable_string_)'></a>
+
+## XfCredentials.AddPrivateKeysFullNames(IEnumerable<string>) Method
+
+Add zero or more full path names to encrypted private keys to add to the collection of credentials.
+
+```csharp
+public void AddPrivateKeysFullNames(System.Collections.Generic.IEnumerable<string> encryptedPrivateKeyFullNames);
+```
+#### Parameters
+
+<a name='Xecrets.Sdk.Models.XfCredentials.AddPrivateKeysFullNames(System.Collections.Generic.IEnumerable_string_).encryptedPrivateKeyFullNames'></a>
+
+`encryptedPrivateKeyFullNames` [System.Collections.Generic.IEnumerable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')
+
+An enumeration of full path names to files containing encrypted  
+            private keys.
+
 <a name='Xecrets.Sdk.Models.XfCredentials.AddPublicKeyEmails(System.Collections.Generic.IEnumerable_string_)'></a>
 
 ## XfCredentials.AddPublicKeyEmails(IEnumerable<string>) Method

sdk-docs/Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.md

@@ -0,0 +1,81 @@
+#### [Xecrets.Sdk](index.md 'index')
+### [Xecrets.Sdk.Models](Xecrets.Sdk.Models.md 'Xecrets.Sdk.Models').[XfEncryptedKeys](Xecrets.Sdk.Models.XfEncryptedKeys.md 'Xecrets.Sdk.Models.XfEncryptedKeys')
+
+## XfEncryptedKeys.EncryptedKey Class
+
+An encrypted private key with additional metadata.
+
+```csharp
+public class XfEncryptedKeys.EncryptedKey :
+System.IEquatable<Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey>
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; EncryptedKey
+
+Implements [System.IEquatable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[EncryptedKey](Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.md 'Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')
+### Properties
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.Email'></a>
+
+## XfEncryptedKeys.EncryptedKey.Email Property
+
+The email address of the user this key belongs to.
+
+```csharp
+public string Email { get; set; }
+```
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.EncryptedKeyPair'></a>
+
+## XfEncryptedKeys.EncryptedKey.EncryptedKeyPair Property
+
+The key pair, with the private key encrypted.
+
+```csharp
+public Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair EncryptedKeyPair { get; set; }
+```
+
+#### Property Value
+[EncryptedKeyPair](Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair.md 'Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair')
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.PrivateKeyStatus'></a>
+
+## XfEncryptedKeys.EncryptedKey.PrivateKeyStatus Property
+
+Wether the private key password was known or unknown when last serialized.
+
+```csharp
+public Xecrets.Sdk.Models.XfEncryptedKeys.PrivateKeyPassword PrivateKeyStatus { get; set; }
+```
+
+#### Property Value
+[PrivateKeyPassword](Xecrets.Sdk.Models.XfEncryptedKeys.md#Xecrets.Sdk.Models.XfEncryptedKeys.PrivateKeyPassword 'Xecrets.Sdk.Models.XfEncryptedKeys.PrivateKeyPassword')
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.Thumbprint'></a>
+
+## XfEncryptedKeys.EncryptedKey.Thumbprint Property
+
+The thumbprint of the key, used to identify it if required.
+
+```csharp
+public string Thumbprint { get; set; }
+```
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.Timestamp'></a>
+
+## XfEncryptedKeys.EncryptedKey.Timestamp Property
+
+The timestamp when the key was created.
+
+```csharp
+public System.DateTime Timestamp { get; set; }
+```
+
+#### Property Value
+[System.DateTime](https://docs.microsoft.com/en-us/dotnet/api/System.DateTime 'System.DateTime')

sdk-docs/Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair.md

@@ -0,0 +1,43 @@
+#### [Xecrets.Sdk](index.md 'index')
+### [Xecrets.Sdk.Models](Xecrets.Sdk.Models.md 'Xecrets.Sdk.Models').[XfEncryptedKeys](Xecrets.Sdk.Models.XfEncryptedKeys.md 'Xecrets.Sdk.Models.XfEncryptedKeys')
+
+## XfEncryptedKeys.EncryptedKeyPair Class
+
+A 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.
+
+```csharp
+public class XfEncryptedKeys.EncryptedKeyPair :
+System.IEquatable<Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair>
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; EncryptedKeyPair
+
+Implements [System.IEquatable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[EncryptedKeyPair](Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair.md 'Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')
+### Properties
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair.EncryptedPrivateKey'></a>
+
+## XfEncryptedKeys.EncryptedKeyPair.EncryptedPrivateKey Property
+
+The encrypted private key pem.
+
+```csharp
+public string EncryptedPrivateKey { get; set; }
+```
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKeyPair.PublicKey'></a>
+
+## XfEncryptedKeys.EncryptedKeyPair.PublicKey Property
+
+The public key pem.
+
+```csharp
+public string PublicKey { get; set; }
+```
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

sdk-docs/Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys.md

@@ -0,0 +1,46 @@
+#### [Xecrets.Sdk](index.md 'index')
+### [Xecrets.Sdk.Models](Xecrets.Sdk.Models.md 'Xecrets.Sdk.Models').[XfEncryptedKeys](Xecrets.Sdk.Models.XfEncryptedKeys.md 'Xecrets.Sdk.Models.XfEncryptedKeys')
+
+## XfEncryptedKeys.EncryptedUserKeys Class
+
+A collection of encrypted private keys for a user, where a user is arbitrarily defined as an email address.
+
+```csharp
+public class XfEncryptedKeys.EncryptedUserKeys :
+System.IEquatable<Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys>
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; EncryptedUserKeys
+
+Implements [System.IEquatable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[EncryptedUserKeys](Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys.md 'Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')
+
+### Remarks
+Normally all the keys belong to the same physical user, but due to email changes etc the keys may be  
+associated with different email addresses.
+### Properties
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys.Email'></a>
+
+## XfEncryptedKeys.EncryptedUserKeys.Email Property
+
+The email address identifier for this list of keys.
+
+```csharp
+public string Email { get; set; }
+```
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+<a name='Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedUserKeys.EncryptedKeys'></a>
+
+## XfEncryptedKeys.EncryptedUserKeys.EncryptedKeys Property
+
+A list of encrypted keys for this email.
+
+```csharp
+public System.Collections.Generic.IList<Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey> EncryptedKeys { get; set; }
+```
+
+#### Property Value
+[System.Collections.Generic.IList&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[EncryptedKey](Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey.md 'Xecrets.Sdk.Models.XfEncryptedKeys.EncryptedKey')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')