streamline docs

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

Author: jkowalleck

schema/bom-1.7.proto

@@ -2195,8 +2195,9 @@ message CryptoProperties {
     optional string algorithmFamily = 2;
     // 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 = 3;
-    // [DEPRECATED] 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 = 4;
+    // 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 = 4 [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.
@@ -2264,14 +2265,16 @@ message CryptoProperties {
     optional google.protobuf.Timestamp notValidBefore = 3;
     // The date and time according to ISO-8601 standard from which the certificate is not valid anymore
     optional google.protobuf.Timestamp notValidAfter = 4;
-    // [DEPRECATED] Use relatedCryptographicAssets instead. The bom-ref to signature algorithm used by the certificate
-    optional string signatureAlgorithmRef = 5;
-    // [DEPRECATED] Use relatedCryptographicAssets instead. The bom-ref to the public key of the subject
-    optional string subjectPublicKeyRef = 6;
+    // DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.relatedCryptographicAssets` instead. The bom-ref to signature algorithm used by the certificate
+    optional string signatureAlgorithmRef = 5 [deprecated = true];
+    // DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.relatedCryptographicAssets` instead. The bom-ref to the public key of the subject
+    optional string subjectPublicKeyRef = 6 [deprecated = true];
     // The format of the certificate. Examples include X.509, PEM, DER, and CVC.
     optional string certificateFormat = 7;
-    // [DEPRECATED] Use certificateFileExtension instead. The file extension of the certificate. Examples include crt, pem, cer, der, and p12.
-    optional string certificateExtension = 8;
+    // DEPRECATED - DO NOT USE - This will be removed in a future version -  Use `.certificateFileExtension` instead. The file extension of the certificate. Examples include crt, pem, cer, der, and p12.
+    optional string certificateExtension = 8 [deprecated = true];
+    // A certificate extension is an optional field that provides additional information about the certificate or its use. Extensions are used to convey additional information beyond the standard fields.
+    optional CertificateExtensions certificateExtensions = 18;
     // The serial number is a unique identifier for the certificate issued by a CA.
     optional string serialNumber = 9;
     // The file extension of the certificate. Examples include crt, pem, cer, der, and p12.
@@ -2290,8 +2293,6 @@ message CryptoProperties {
     optional google.protobuf.Timestamp revocationDate = 16;
     // The date and time (timestamp) when the certificate was destroyed.
     optional google.protobuf.Timestamp destructionDate = 17;
-    // A certificate extension is an optional field that provides additional information about the certificate or its use. Extensions are used to convey additional information beyond the standard fields.
-    optional CertificateExtensions certificateExtensions = 18;
     // A list of cryptographic assets related to this component.
     optional RelatedCryptographicAssets relatedCryptographicAssets = 19;
   } // end of CertificateProperties
@@ -2414,8 +2415,8 @@ message CryptoProperties {
     optional string id = 2;
     // The key state as defined by NIST SP 800-57.
     optional CryptoRelatedState state = 3;
-    // [DEPRECATED] Use relatedCryptographicAssets instead. The bom-ref to the algorithm used to generate the related cryptographic material.
-    optional string algorithmRef = 4;
+    // DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.relatedCryptographicAssets` instead. The bom-ref to the algorithm used to generate the related cryptographic material.
+    optional string algorithmRef = 4 [deprecated = true];
     // The date and time (timestamp) when the related cryptographic material was created.
     optional google.protobuf.Timestamp creationDate = 5;
     // The date and time (timestamp) when the related cryptographic material was activated.

schema/bom-1.7.schema.json

@@ -5126,10 +5126,10 @@
               "description": "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)."
             },
             "curve": {
+              "deprecated": true,
               "type": "string",
               "title": "Elliptic Curve",
-              "description": "[Deprecated] 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 using curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source of which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves).",
-              "deprecated": true
+              "description": "[Deprecated] This will be removed in a future version. Use `@.ellipticCurve` instead.\nThe 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 using curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source of which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves)."
             },
             "ellipticCurve": {
               "$ref": "cryptography-defs.schema.json#/definitions/ellipticCurvesEnum",
@@ -5373,13 +5373,13 @@
               "deprecated": true,
               "$ref": "#/definitions/refType",
               "title": "Algorithm Reference",
-              "description": "[DEPRECATED] Use relatedCryptographicAssets instead. The bom-ref to signature algorithm used by the certificate"
+              "description": "[DEPRECATED] This will be removed in a future version. Use `@.relatedCryptographicAssets` instead.\nThe bom-ref to signature algorithm used by the certificate"
             },
             "subjectPublicKeyRef": {
               "deprecated": true,
               "$ref": "#/definitions/refType",
               "title": "Key reference",
-              "description": "[DEPRECATED] Use relatedCryptographicAssets instead. The bom-ref to the public key of the subject"
+              "description": "[DEPRECATED] This will be removed in a future version. Use `@.relatedCryptographicAssets` instead. The bom-ref to the public key of the subject"
             },
             "certificateFormat": {
               "type": "string",
@@ -5396,7 +5396,7 @@
               "deprecated": true,
               "type": "string",
               "title": "Certificate File Extension",
-              "description": "[DEPRECATED] Use certificateFileExtension instead. The file extension of the certificate",
+              "description": "[DEPRECATED] This will be removed in a future version. Use `@.certificateFileExtension` instead.\nThe file extension of the certificate",
               "examples": [
                 "crt",
                 "pem",
@@ -5682,7 +5682,7 @@
               "deprecated": true,
               "$ref": "#/definitions/refType",
               "title": "Algorithm Reference",
-              "description": "[DEPRECATED] Use relatedCryptographicAssets instead. The bom-ref to the algorithm used to generate the related cryptographic material."
+              "description": "[DEPRECATED] Use `relatedCryptographicAssets` instead.\nThe bom-ref to the algorithm used to generate the related cryptographic material."
             },
             "creationDate": {
               "type": "string",
@@ -5819,7 +5819,7 @@
                     "$ref": "#/definitions/ikeV2Enc",
                     "title": "Encryption Algorithm (ENCR)"
                   }
-                },  
+                },
                 "prf": {
                   "type": "array",
                   "title": "Pseudorandom Functions (PRF)",
@@ -5867,7 +5867,7 @@
               "deprecated": true,
               "$ref": "#/definitions/cryptoRefArray",
               "title": "Cryptographic References",
-              "description": "[DEPRECATED] Use relatedCryptographicAssets instead. A list of protocol-related cryptographic assets"
+              "description": "[DEPRECATED] Use `r`elatedCryptographicAssets` instead. A list of protocol-related cryptographic assets"
             },
             "relatedCryptographicAssets": {
               "$ref": "#/definitions/relatedCryptographicAssets",

schema/bom-1.7.xsd

@@ -6546,7 +6546,7 @@ limitations under the License.
                         <xs:element name="curve" type="xs:string" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
                                 <xs:documentation>
-                                    DEPRECATED. Use ellipticCurve instead.
+                                    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
@@ -7095,15 +7095,15 @@ limitations under the License.
                         <xs:element name="signatureAlgorithmRef" type="bom:refType" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
                                 <xs:documentation>
-                                    DEPRECATED] Use relatedCryptographicAssets instead.
+                                    DEPRECATED - DO NOT USE. This will be removed in a future version. Use `./relatedCryptographicAssets` instead.
                                     The bom-ref to signature algorithm used by the certificate
                                 </xs:documentation>
                             </xs:annotation>
                         </xs:element>
                         <xs:element name="subjectPublicKeyRef" type="bom:refType" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
                                 <xs:documentation>
-                                    DEPRECATED] Use relatedCryptographicAssets instead.
+                                    DEPRECATED - DO NOT USE. This will be removed in a future version. Use `./relatedCryptographicAssets` instead.
                                     The bom-ref to the public key of the subject
                                 </xs:documentation>
                             </xs:annotation>
@@ -7118,7 +7118,7 @@ limitations under the License.
                         <xs:element name="certificateExtension" type="xs:string" minOccurs="0" maxOccurs="1">
                             <xs:annotation>
                                 <xs:documentation>
-                                    [DEPRECATED] Use certificateFileExtension instead.
+                                    DEPRECATED - DO NOT USE. This will be removed in a future version. Use `./certificateFileExtension` instead.
                                     The file extension of the certificate. Examples include crt, pem, cer, der, and p12.
                                 </xs:documentation>
                             </xs:annotation>