From 815f99d0c21263a91d4a501713badcf3528e1a06 Mon Sep 17 00:00:00 2001
From: mgrojo <mgrojo@gmail.com>
Date: Tue, 7 Jan 2025 23:12:14 +0100
Subject: [PATCH] Ada binding: improve comments and arguments in the PSK case

- Add comments for the PSK value in the example.
- Add runtime argument for executing the PSK test.
- Warn user that their callback implementation can't be in the SPARK subset.
---
 wrapper/Ada/tls_client.adb | 29 ++++++++++++++++++++---------
 wrapper/Ada/wolfssl.ads    |  3 +++
 2 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/wrapper/Ada/tls_client.adb b/wrapper/Ada/tls_client.adb
index 1e109d7afd..c40953dcf8 100644
--- a/wrapper/Ada/tls_client.adb
+++ b/wrapper/Ada/tls_client.adb
@@ -63,17 +63,23 @@ package body Tls_Client with SPARK_Mode is
       Key            : chars_ptr;
       Key_Max_Length : unsigned) return unsigned
    with
-     SPARK_Mode => Off      
+     SPARK_Mode => Off
    is
       use type Interfaces.C.unsigned;
 
       Hint_String : constant String := Interfaces.C.Strings.Value (Hint);
+
+      --  Identity is OpenSSL testing default for openssl s_client, keep same
       Identity_String : constant String := "Client_identity";
+      --  Test key in hex is 0x1a2b3c4d, in decimal 439,041,101
       Key_String : constant String :=
         Character'Val   (26)
         & Character'Val (43)
         & Character'Val (60)
         & Character'Val (77);
+      --  These values are aligned with test values in wolfssl/wolfssl/test.h
+      --  and wolfssl-examples/psk/server-psk.c for testing interoperability.
+
    begin
 
       Ada.Text_IO.Put_Line ("Hint: " & Hint_String);
@@ -199,6 +205,7 @@ package body Tls_Client with SPARK_Mode is
 
       Result : WolfSSL.Subprogram_Result;
       DTLS   : Boolean;
+      PSK    : Boolean;
    begin
       Result := WolfSSL.Initialize;
       if Result /= Success then
@@ -208,13 +215,19 @@ package body Tls_Client with SPARK_Mode is
 
       if Argument_Count < 1
          or Argument_Count > 2
-         or (Argument_Count = 2 and then Argument (2) /= "--dtls")
+         or (Argument_Count = 2 and then
+             Argument (2) /= "--dtls" and then
+             Argument (2) /= "--psk")
       then
-         Put_Line ("usage: tls_client_main <IPv4 address> [--dtls]");
+         Put_Line ("usage: tls_client_main <IPv4 address> [--dtls | --psk]");
          return;
       end if;
 
-      DTLS := (SPARK_Terminal.Argument_Count = 2);
+      DTLS := (SPARK_Terminal.Argument_Count = 2 and then
+                Argument (2) = "--dtls");
+
+      PSK := (SPARK_Terminal.Argument_Count = 2 and then
+                Argument (2) = "--psk");
 
       if DTLS then
          SPARK_Sockets.Create_Datagram_Socket (C);
@@ -276,8 +289,7 @@ package body Tls_Client with SPARK_Mode is
          (Context => Ctx,
           Mode    => WolfSSL.Verify_Peer or WolfSSL.Verify_Fail_If_No_Peer_Cert);
 
-      if Ada.Directories.Exists (CERT_FILE) and then
-         Ada.Directories.Exists (KEY_FILE) then
+      if not PSK then
 
          --  Load client certificate into WOLFSSL_CTX.
          Result := WolfSSL.Use_Certificate_File (Context => Ctx,
@@ -335,10 +347,9 @@ package body Tls_Client with SPARK_Mode is
          return;
       end if;
 
-      if not (Ada.Directories.Exists (CERT_FILE) and then
-              Ada.Directories.Exists (KEY_FILE)) then
+      if PSK then
 
-         -- Use PSK for authentication.
+         --  Use PSK for authentication.
          WolfSSL.Set_PSK_Client_Callback
            (Ssl      => Ssl,
             Callback => PSK_Client_Callback'Access);
diff --git a/wrapper/Ada/wolfssl.ads b/wrapper/Ada/wolfssl.ads
index 7133881272..3edc17cfc3 100644
--- a/wrapper/Ada/wolfssl.ads
+++ b/wrapper/Ada/wolfssl.ads
@@ -318,6 +318,9 @@ package WolfSSL with SPARK_Mode is
      --  Id_Max_Length - Size of the ID buffer.
      --  Key - The key will be stored here.
      --  Key_Max_Length - The max size of the key.
+     --
+     --  The implementation of this callback will need `SPARK_Mode => Off`
+     --  since it will require the code to use the C memory model.
 
    procedure Set_PSK_Client_Callback
      (Ssl      : WolfSSL_Type;