Document IDP key format requirement

We currently require SAML private keys to be in RSA PKCS#1 format, but do not mention this in our doc string. Update the doc string to explicitly list the required format.
oxidecomputer · Nov 18, 2024 · b813310 · b813310
1 parent 8a6182a
commit b813310
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/nexus/types/src/external_api/params.rs b/nexus/types/src/external_api/params.rs
@@ -584,7 +584,7 @@ pub struct DerEncodedKeyPair {
     #[serde(deserialize_with = "x509_cert_from_base64_encoded_der")]
     pub public_cert: String,
 
-    /// request signing private key (base64 encoded der file)
+    /// request signing RSA private key in PKCS#1 format (base64 encoded der file)
     #[serde(deserialize_with = "key_from_base64_encoded_der")]
     pub private_key: String,
 }

diff --git a/openapi/nexus.json b/openapi/nexus.json
@@ -13217,7 +13217,7 @@
         "type": "object",
         "properties": {
           "private_key": {
-            "description": "request signing private key (base64 encoded der file)",
+            "description": "request signing RSA private key in PKCS#1 format (base64 encoded der file)",
             "type": "string"
           },
           "public_cert": {