]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: enumerate and describe known reserved property names
authorRichard Levitte <levitte@openssl.org>
Thu, 19 Feb 2026 12:30:13 +0000 (13:30 +0100)
committerTomas Mraz <tomas@openssl.org>
Wed, 25 Feb 2026 10:59:56 +0000 (11:59 +0100)
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
MergeDate: Wed Feb 25 11:00:15 2026
(Merged from https://github.com/openssl/openssl/pull/30083)

doc/man7/property.pod

index eb0f6b176ccb9ab0f7845f10e85cea2ba44f362b..594a72956ebed87591d18e2b97a54a5b33d668a5 100644 (file)
@@ -142,6 +142,38 @@ Note that the local property query could not use "fips=no" because that would
 disallow any implementations with "fips=yes" rather than not caring about the
 setting.
 
+=head1 PREDEFINED NAMES
+
+=for comment This list should correspond to the array 'predefined_names' in crypto/property/property_parse.c
+
+Currently known predefined names are:
+
+=over 4
+
+=item C<provider>
+
+The conventional property value is the provider's name.  This may be different from the name returned by L<OSSL_PROVIDER_get0_name(3)>.
+
+It is a convention among OpenSSL provider implementations to define a property with this name.  It is not mandatory to do this.
+
+=item C<version>
+
+The conventional property value is the provider's version.
+
+OpenSSL provider implementations do not define a property with this name.
+
+=item C<fips>
+
+The conventional property value is boolean (C<"yes"> or C<"no">), indication whether the implementation conforms to FIPS standards or not.
+
+It is a convention among OpenSSL provider implementations to define a property with this name where applicable.  It is not mandatory to do this, but is strongly recommended.
+
+=item C<output>, C<input>, C<structure>
+
+Properties with these names are used by encoders (see L<provider-encoder(7)>) and decoders (see L<provider-decoder(7)>).
+
+=back
+
 =head1 SYNTAX
 
 The lexical syntax in EBNF is given by: