diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man7/property.7')
| -rw-r--r-- | secure/lib/libcrypto/man/man7/property.7 | 152 |
1 files changed, 38 insertions, 114 deletions
diff --git a/secure/lib/libcrypto/man/man7/property.7 b/secure/lib/libcrypto/man/man7/property.7 index 691741356a6e..02838850cadd 100644 --- a/secure/lib/libcrypto/man/man7/property.7 +++ b/secure/lib/libcrypto/man/man7/property.7 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,77 +52,17 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PROPERTY 7ossl" -.TH PROPERTY 7ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH PROPERTY 7ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME property \- Properties, a selection mechanism for algorithm implementations -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" As of OpenSSL 3.0, a new method has been introduced to decide which of multiple implementations of an algorithm will be used. @@ -171,29 +95,29 @@ property names like \& <provider_name>.<property_name> \& <provider_name>.<algorithm_name>.<property_name> .Ve -.SS "Properties" +.SS Properties .IX Subsection "Properties" A \fIproperty\fR is a \fIname=value\fR pair. A \fIproperty definition\fR is a sequence of comma separated properties. There can be any number of properties in a definition, however each name must be unique. -For example: "\*(L" defines an empty property definition (i.e., no restriction); -\&\*(R"my.foo=bar" defines a property named \fImy.foo\fR which has a string value \fIbar\fR -and \*(L"iteration.count=3\*(R" defines a property named \fIiteration.count\fR which +For example: "" defines an empty property definition (i.e., no restriction); +"my.foo=bar" defines a property named \fImy.foo\fR which has a string value \fIbar\fR +and "iteration.count=3" defines a property named \fIiteration.count\fR which has a numeric value of \fI3\fR. The full syntax for property definitions appears below. -.SS "Implementations" +.SS Implementations .IX Subsection "Implementations" Each implementation of an algorithm can define any number of properties. For example, the default provider defines the property \fIprovider=default\fR for all of its algorithms. -Likewise, OpenSSL's \s-1FIPS\s0 provider defines \fIprovider=fips\fR and the legacy +Likewise, OpenSSL's FIPS provider defines \fIprovider=fips\fR and the legacy provider defines \fIprovider=legacy\fR for all of their algorithms. -.SS "Queries" +.SS Queries .IX Subsection "Queries" A \fIproperty query clause\fR is a single conditional test. -For example, \*(L"fips=yes\*(R", \*(L"provider!=default\*(R" or \*(L"?iteration.count=3\*(R". +For example, "fips=yes", "provider!=default" or "?iteration.count=3". The first two represent mandatory clauses, such clauses \fBmust\fR match for any algorithm to even be under consideration. The third clause represents an optional clause. @@ -204,23 +128,23 @@ A \fIproperty query\fR is a sequence of comma separated property query clauses. It is an error if a property name appears in more than one query clause. The full syntax for property queries appears below, but the available syntactic features are: -.IP "\(bu" 4 +.IP \(bu 4 \&\fB=\fR is an infix operator providing an equality test. -.IP "\(bu" 4 +.IP \(bu 4 \&\fB!=\fR is an infix operator providing an inequality test. -.IP "\(bu" 4 +.IP \(bu 4 \&\fB?\fR is a prefix operator that means that the following clause is optional but preferred. -.IP "\(bu" 4 +.IP \(bu 4 \&\fB\-\fR is a prefix operator that means any global query clause involving the following property name should be ignored. -.IP "\(bu" 4 -\&\fB\*(L"...\*(R"\fR is a quoted string. +.IP \(bu 4 +\&\fB"..."\fR is a quoted string. The quotes are not included in the body of the string. -.IP "\(bu" 4 +.IP \(bu 4 \&\fB'...'\fR is a quoted string. The quotes are not included in the body of the string. -.SS "Lookups" +.SS Lookups .IX Subsection "Lookups" When an algorithm is looked up, a property query is used to determine the best matching algorithm. @@ -230,11 +154,11 @@ clauses will be used. If there is more than one such optimal candidate, the result will be chosen from amongst those in an indeterminate way. Ordering of optional clauses is not significant. -.SS "Shortcut" +.SS Shortcut .IX Subsection "Shortcut" In order to permit a more concise expression of boolean properties, there -is one short cut: a property name alone (e.g. \*(L"my.property\*(R") is -exactly equivalent to \*(L"my.property=yes\*(R" in both definitions and queries. +is one short cut: a property name alone (e.g. "my.property") is +exactly equivalent to "my.property=yes" in both definitions and queries. .SS "Global and Local" .IX Subsection "Global and Local" Two levels of property query are supported. @@ -245,18 +169,18 @@ the local clause overrides the context clause. .PP It is possible for a local property query to remove a clause in the context property query by preceding the property name with a '\-'. -For example, a context property query that contains \*(L"fips=yes\*(R" would normally -result in implementations that have \*(L"fips=yes\*(R". +For example, a context property query that contains "fips=yes" would normally +result in implementations that have "fips=yes". .PP -However, if the setting of the \*(L"fips\*(R" property is irrelevant to the +However, if the setting of the "fips" property is irrelevant to the operations being performed, the local property query can include the -clause \*(L"\-fips\*(R". -Note that the local property query could not use \*(L"fips=no\*(R" because that would -disallow any implementations with \*(L"fips=yes\*(R" rather than not caring about the +clause "\-fips". +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. -.SH "SYNTAX" +.SH SYNTAX .IX Header "SYNTAX" -The lexical syntax in \s-1EBNF\s0 is given by: +The lexical syntax in EBNF is given by: .PP .Vb 11 \& Definition ::= PropertyName ( \*(Aq=\*(Aq Value )? @@ -272,16 +196,16 @@ The lexical syntax in \s-1EBNF\s0 is given by: \& PropertyName ::= [A\-Za\-z] [A\-Za\-z0\-9_]* ( \*(Aq.\*(Aq [A\-Za\-z] [A\-Za\-z0\-9_]* )* .Ve .PP -The flavour of \s-1EBNF\s0 being used is defined by: +The flavour of EBNF being used is defined by: <https://www.w3.org/TR/2010/REC\-xquery\-20101214/#EBNFNotation>. -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" Properties were added in OpenSSL 3.0 -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |