Formating

Basic Pester
Update documentation

Author: virot

Docs/Commands/Set-YubikeyOTP.md

@@ -5,7 +5,7 @@ online version:
 schema: 2.0.0
 ---
 
-# Set-YubikeyOTP
+# Set-YubiKeyOTP
 
 ## SYNOPSIS
 Configure OTP slots
@@ -14,28 +14,34 @@ Configure OTP slots
 
 ### Yubico OTP
 ```
-Set-YubikeyOTP -Slot <Slot> [-YubicoOTP] [-PublicID <Byte[]>] [-PrivateID <Byte[]>] [-SecretKey <Byte[]>]
+Set-YubiKeyOTP -Slot <Slot> [-YubicoOTP] [-PublicID <Byte[]>] [-PrivateID <Byte[]>] [-SecretKey <Byte[]>]
  [-Upload] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### Static Password
 ```
-Set-YubikeyOTP -Slot <Slot> [-StaticPassword] -Password <SecureString> [-KeyboardLayout <KeyboardLayout>]
+Set-YubiKeyOTP -Slot <Slot> [-StaticPassword] -Password <SecureString> [-KeyboardLayout <KeyboardLayout>]
  [-AppendCarriageReturn] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### Static Generated Password
 ```
-Set-YubikeyOTP -Slot <Slot> [-StaticGeneratedPassword] -PasswordLength <Int32>
+Set-YubiKeyOTP -Slot <Slot> [-StaticGeneratedPassword] -PasswordLength <Int32>
  [-KeyboardLayout <KeyboardLayout>] [-AppendCarriageReturn] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ChallengeResponse
 ```
-Set-YubikeyOTP -Slot <Slot> [-ChallengeResponse] [-SecretKey <Byte[]>]
+Set-YubiKeyOTP -Slot <Slot> [-ChallengeResponse] [-SecretKey <Byte[]>]
  [-Algorithm <ChallengeResponseAlgorithm>] [-RequireTouch] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
+### HOTP
+```
+Set-YubiKeyOTP -Slot <Slot> [-SecretKey <Byte[]>] [-AppendCarriageReturn] [-HOTP] [-Base32Secret <String>]
+ [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
 ## DESCRIPTION
 Allows the configuration of the YubiKey OTP slots (2). The YubiKey OTP slots can be configured with: 
 
@@ -105,7 +111,22 @@ field and "pressing Enter" on behalf of the user.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: Static Password, Static Generated Password
+Parameter Sets: Static Password, Static Generated Password, HOTP
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Base32Secret
+Base32 encoded secret key for HOTP
+
+```yaml
+Type: String
+Parameter Sets: HOTP
 Aliases:
 
 Required: False
@@ -130,6 +151,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -HOTP
+Allows configuration of HOTP mode
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: HOTP
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -KeyboardLayout
 Keyboard layout to be used.
 
@@ -226,7 +262,7 @@ Sets the Secret Key, defaults to random 16 bytes.
 
 ```yaml
 Type: Byte[]
-Parameter Sets: Yubico OTP, ChallengeResponse
+Parameter Sets: Yubico OTP, ChallengeResponse, HOTP
 Aliases:
 
 Required: False

Module/Cmdlets/OTP/SetYubikeyOTP.cs

@@ -168,13 +168,13 @@ protected override void BeginProcessing()
 
 
         /// Main processing method that configures the YubiKey OTP settings based on the selected mode
-          protected override void ProcessRecord()
+        protected override void ProcessRecord()
         {
             using (var otpSession = new OtpSession((YubiKeyDevice)YubiKeyModule._yubikey!))
             {
                 WriteDebug($"Working with {ParameterSetName}");
-                if ((Slot == Yubico.YubiKey.Otp.Slot.ShortPress && !otpSession.IsShortPressConfigured) || 
-                    (Slot == Yubico.YubiKey.Otp.Slot.LongPress && !otpSession.IsLongPressConfigured) || 
+                if ((Slot == Yubico.YubiKey.Otp.Slot.ShortPress && !otpSession.IsShortPressConfigured) ||
+                    (Slot == Yubico.YubiKey.Otp.Slot.LongPress && !otpSession.IsLongPressConfigured) ||
                     ShouldProcess($"Yubikey OTP {Slot}", "Set"))
                 {
                     switch (ParameterSetName)
@@ -268,7 +268,7 @@ protected override void ProcessRecord()
                             // Configure challenge-response mode
                             Memory<byte> _CRsecretKey = new Memory<byte>(new byte[20]);
                             ConfigureChallengeResponse configureCR = otpSession.ConfigureChallengeResponse(Slot);
-                            
+
                             // Handle Secret Key configuration
                             if (SecretKey is null)
                             {
@@ -310,7 +310,7 @@ protected override void ProcessRecord()
                             // Configure HOTP mode
                             Memory<byte> _HOTPsecretKey = new Memory<byte>(new byte[20]);
                             ConfigureHotp configureHOTP = otpSession.ConfigureHotp(Slot);
-                            
+
                             // Handle Secret Key configuration
                             if (Base32Secret != null)
                             {
@@ -336,7 +336,8 @@ protected override void ProcessRecord()
                             configureHOTP.Execute();
 
                             // Return both raw and Base32 representations of the key
-                            WriteObject(new { 
+                            WriteObject(new
+                            {
                                 SecretKey = _HOTPsecretKey.ToArray(),
                                 Base32Secret = powershellYK.support.Base32.Encode(_HOTPsecretKey.ToArray())
                             });

Module/support/Base32.cs

@@ -90,4 +90,4 @@ public static byte[] Decode(string base32String)
             return result;
         }
     }
-} 
+}

Pester/420-OTP-HOTP.tests.ps1

@@ -0,0 +1,13 @@
+Describe "OTP HOTP Tests" -Tag "OTP",'OTP-HOTP'  {
+    It -Name "Setting should not throw" -Test {
+        {$return = Set-YubiKeyOTP -Slot ShortPress -HOTP -SecretKey ([byte[]]@(2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21)) -Confirm:$false} | Should -Not -Throw
+    }
+    It -Name "Verify that it sets it correctly" -Test {
+        $return = Set-YubiKeyOTP -Slot ShortPress -HOTP -SecretKey ([byte[]]@(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20)) -Confirm:$false
+	$return.Base32Secret | Should -Be "AEBAGBAFAYDQQCIKBMGA2DQPCAIREEYU"
+    }
+    It -Name "Verify that it sets it correctly from Base32" -Test {
+        $return = Set-YubiKeyOTP -Slot ShortPress -HOTP -Base32Secret 'QRFJ7DTIVASL3PNYXWFIQAQN5RKUJD4U' -Confirm:$false
+	$return.SecretKey | Should -Be @(0x84, 0x4a, 0x9f, 0x8e, 0x68, 0xa8, 0x24, 0xbd, 0xbd, 0xb8, 0xbd, 0x8a, 0x88, 0x02, 0x0d, 0xec, 0x55, 0x44, 0x8f, 0x94)
+    }
+}