docs

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

schema/bom-1.7.proto

@@ -2288,18 +2288,16 @@ message CryptoProperties {
 
     // Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).
     optional CryptoPrimitive primitive = 1;
-    // A valid algorithm family identifier. If specified, this value must be one of the
-    // enumeration of valid algorithm Family identifiers defined in the
-    // `cryptography-defs.json` subschema. A corresponding schema for ProtoBuf is not available.
+    // A valid algorithm family identifier.
+    // If specified, this value must be one of the enumeration of valid algorithm Family identifiers defined in the `cryptography-defs.schema.json` subschema. A corresponding schema for ProtoBuf is not available.
     optional string algorithmFamily = 12;
     // An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).
     optional string parameterSetIdentifier = 2;
     // DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.ellipticCurve` Instead.
     // The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends use of curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source from which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves).
     optional string curve = 3 [deprecated = true];
-    // The specific underlying Elliptic Curve (EC) definition employed which is an indicator
-    // of the level of security strength, performance and complexity. Curves are defined in
-    // the `cryptography-defs.json` subschema. A corresponding schema for ProtoBuf is not available.
+    // The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity.
+    // If specified, this value must be one of the enumeration of valid elliptic curves identifiers defined in the `cryptography-defs.schema.json` subschema. A corresponding schema for ProtoBuf is not available.
     optional string ellipticCurve = 13;
     // The target and execution environment in which the algorithm is implemented in.
     optional CryptoExecutionEnvironment executionEnvironment = 4;

schema/bom-1.7.schema.json

@@ -5289,7 +5289,7 @@
             "ellipticCurve": {
               "$ref": "cryptography-defs.schema.json#/definitions/ellipticCurvesEnum",
               "title": "Elliptic Curve",
-              "description": "The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity."
+              "description": "The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. If specified, this value must be one of the enumeration of valid elliptic curves identifiers defined in the `cryptography-defs.schema.json` subschema."
             },
             "executionEnvironment": {
               "type": "string",

schema/bom-1.7.xsd

@@ -6772,9 +6772,8 @@ limitations under the License.
                         <xs:element name="algorithmFamily" type="xs:string" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
                                 <xs:documentation>
-                                    A valid algorithm family identifier. If specified, this value must be one of the
-                                    enumeration of valid algorithm Family identifiers defined in the
-                                    `cryptography-defs.json` subschema. A corresponding schema for XML is not available.
+                                    A valid algorithm family identifier.
+                                    If specified, this value must be one of the enumeration of valid algorithm Family identifiers defined in the `cryptography-defs.schema.json` subschema. A corresponding schema for XML is not available.
                                 </xs:documentation>
                             </xs:annotation>
                         </xs:element>
@@ -6803,9 +6802,8 @@ limitations under the License.
                         <xs:element name="ellipticCurve" type="xs:string" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
                                 <xs:documentation>
-                                    The specific underlying Elliptic Curve (EC) definition employed which is an indicator
-                                    of the level of security strength, performance and complexity. Curves are defined in
-                                    the `cryptography-defs.json` subschema. A corresponding schema for XML is not available.
+                                    The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity.
+                                    If specified, this value must be one of the enumeration of valid elliptic curves identifiers defined in the `cryptography-defs.schema.json` subschema. A corresponding schema for XML is not available.
                                 </xs:documentation>
                             </xs:annotation>
                         </xs:element>