diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_SELF_TEST_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_SELF_TEST_new.3 | 289 |
1 files changed, 289 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_SELF_TEST_new.3 b/secure/lib/libcrypto/man/man3/OSSL_SELF_TEST_new.3 new file mode 100644 index 000000000000..0aa376f9b0ab --- /dev/null +++ b/secure/lib/libcrypto/man/man3/OSSL_SELF_TEST_new.3 @@ -0,0 +1,289 @@ +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.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' +.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\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.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 "OSSL_SELF_TEST_NEW 3ossl" +.TH OSSL_SELF_TEST_NEW 3ossl "2023-09-19" "3.0.11" "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" +OSSL_SELF_TEST_new, +OSSL_SELF_TEST_free, +OSSL_SELF_TEST_onbegin, +OSSL_SELF_TEST_oncorrupt_byte, +OSSL_SELF_TEST_onend \- functionality to trigger a callback during a self test +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/self_test.h> +\& +\& OSSL_SELF_TEST *OSSL_SELF_TEST_new(OSSL_CALLBACK *cb, void *cbarg); +\& void OSSL_SELF_TEST_free(OSSL_SELF_TEST *st); +\& +\& void OSSL_SELF_TEST_onbegin(OSSL_SELF_TEST *st, const char *type, +\& const char *desc); +\& int OSSL_SELF_TEST_oncorrupt_byte(OSSL_SELF_TEST *st, unsigned char *bytes); +\& void OSSL_SELF_TEST_onend(OSSL_SELF_TEST *st, int ret); +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +These methods are intended for use by provider implementers, to display +diagnostic information during self testing. +.PP +\&\fBOSSL_SELF_TEST_new()\fR allocates an opaque \fB\s-1OSSL_SELF_TEST\s0\fR object that has a +callback and callback argument associated with it. +.PP +The callback \fIcb\fR may be triggered multiple times by a self test to indicate +different phases. +.PP +\&\fBOSSL_SELF_TEST_free()\fR frees the space allocated by \fBOSSL_SELF_TEST_new()\fR. +.PP +\&\fBOSSL_SELF_TEST_onbegin()\fR may be inserted at the start of a block of self test +code. It can be used for diagnostic purposes. +If this method is called the callback \fIcb\fR will receive the following +\&\s-1\fBOSSL_PARAM\s0\fR\|(3) object. +.ie n .IP """st-phase"" (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_PHASE\s0\fR) <\s-1UTF8\s0 string>" 4 +.el .IP "``st-phase'' (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_PHASE\s0\fR) <\s-1UTF8\s0 string>" 4 +.IX Item "st-phase (OSSL_PROV_PARAM_SELF_TEST_PHASE) <UTF8 string>" +The value is the string \*(L"Start\*(R" +.PP +\&\fBOSSL_SELF_TEST_oncorrupt_byte()\fR may be inserted just after the known answer is +calculated, but before the self test compares the result. The first byte in the +passed in array of \fIbytes\fR will be corrupted if the callback returns 0, +otherwise it leaves the array unaltered. It can be used for failure testing. +The \fItype\fR and \fIdesc\fR can be used to identify an individual self test to +target for failure testing. +If this method is called the callback \fIcb\fR will receive the following +\&\s-1\fBOSSL_PARAM\s0\fR\|(3) object. +.ie n .IP """st-phase"" (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_PHASE\s0\fR) <\s-1UTF8\s0 string>" 4 +.el .IP "``st-phase'' (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_PHASE\s0\fR) <\s-1UTF8\s0 string>" 4 +.IX Item "st-phase (OSSL_PROV_PARAM_SELF_TEST_PHASE) <UTF8 string>" +The value is the string \*(L"Corrupt\*(R" +.PP +\&\fBOSSL_SELF_TEST_onend()\fR may be inserted at the end of a block of self test code +just before cleanup to indicate if the test passed or failed. It can be used for +diagnostic purposes. +If this method is called the callback \fIcb\fR will receive the following +\&\s-1\fBOSSL_PARAM\s0\fR\|(3) object. +.ie n .IP """st-phase"" (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_PHASE\s0\fR) <\s-1UTF8\s0 string>" 4 +.el .IP "``st-phase'' (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_PHASE\s0\fR) <\s-1UTF8\s0 string>" 4 +.IX Item "st-phase (OSSL_PROV_PARAM_SELF_TEST_PHASE) <UTF8 string>" +The value of the string is \*(L"Pass\*(R" if \fIret\fR is non zero, otherwise it has the +value \*(L"Fail\*(R". +.PP +After the callback \fIcb\fR has been called the values that were set by +\&\fBOSSL_SELF_TEST_onbegin()\fR for \fItype\fR and \fIdesc\fR are set to the value \*(L"None\*(R". +.PP +If \fBOSSL_SELF_TEST_onbegin()\fR, \fBOSSL_SELF_TEST_oncorrupt_byte()\fR or +\&\fBOSSL_SELF_TEST_onend()\fR is called the following additional \s-1\fBOSSL_PARAM\s0\fR\|(3) are +passed to the callback. +.ie n .IP """st-type"" (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_TYPE\s0\fR) <\s-1UTF8\s0 string>" 4 +.el .IP "``st-type'' (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_TYPE\s0\fR) <\s-1UTF8\s0 string>" 4 +.IX Item "st-type (OSSL_PROV_PARAM_SELF_TEST_TYPE) <UTF8 string>" +The value is setup by the \fItype\fR passed to \fBOSSL_SELF_TEST_onbegin()\fR. +This allows the callback to identify the type of test being run. +.ie n .IP """st-desc"" (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_DESC\s0\fR) <\s-1UTF8\s0 string>" 4 +.el .IP "``st-desc'' (\fB\s-1OSSL_PROV_PARAM_SELF_TEST_DESC\s0\fR) <\s-1UTF8\s0 string>" 4 +.IX Item "st-desc (OSSL_PROV_PARAM_SELF_TEST_DESC) <UTF8 string>" +The value is setup by the \fItype\fR passed to \fBOSSL_SELF_TEST_onbegin()\fR. +This allows the callback to identify the sub category of the test being run. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBOSSL_SELF_TEST_new()\fR returns the allocated \fB\s-1OSSL_SELF_TEST\s0\fR object, or \s-1NULL\s0 if +it fails. +.PP +\&\fBOSSL_SELF_TEST_oncorrupt_byte()\fR returns 1 if corruption occurs, otherwise it +returns 0. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +A single self test could be set up in the following way: +.PP +.Vb 8 +\& OSSL_SELF_TEST *st = NULL; +\& OSSL_CALLBACK *cb; +\& void *cbarg; +\& int ok = 0; +\& unsigned char out[EVP_MAX_MD_SIZE]; +\& unsigned int out_len = 0; +\& EVP_MD_CTX *ctx = EVP_MD_CTX_new(); +\& EVP_MD *md = EVP_MD_fetch(libctx, t\->algorithm, NULL); +\& +\& /* +\& * Retrieve the callback \- will be NULL if not set by the application via +\& * OSSL_SELF_TEST_set_callback(). +\& */ +\& OSSL_SELF_TEST_get_callback(libctx, &cb, &cbarg); +\& +\& st = OSSL_SELF_TEST_new(cb, cb_arg); +\& +\& /* Trigger the optional callback */ +\& OSSL_SELF_TEST_onbegin(st, OSSL_SELF_TEST_TYPE_KAT_DIGEST, +\& OSSL_SELF_TEST_DESC_MD_SHA2); +\& +\& if (!EVP_DigestInit_ex(ctx, md, NULL) +\& || !EVP_DigestUpdate(ctx, pt, pt_len) +\& || !EVP_DigestFinal(ctx, out, &out_len)) +\& goto err; +\& +\& /* Optional corruption \- If the application callback returns 0 */ +\& OSSL_SELF_TEST_oncorrupt_byte(st, out); +\& +\& if (out_len != t\->expected_len +\& || memcmp(out, t\->expected, out_len) != 0) +\& goto err; +\& ok = 1; +\& err: +\& OSSL_SELF_TEST_onend(st, ok); +\& EVP_MD_free(md); +\& EVP_MD_CTX_free(ctx); +.Ve +.PP +Multiple self test's can be set up in a similar way by repeating the pattern of +\&\fBOSSL_SELF_TEST_onbegin()\fR, \fBOSSL_SELF_TEST_oncorrupt_byte()\fR, \fBOSSL_SELF_TEST_onend()\fR +for each test. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBOSSL_SELF_TEST_set_callback\fR\|(3), +\&\fBopenssl\-core.h\fR\|(7), +\&\s-1\fBOSSL_PROVIDER\-FIPS\s0\fR\|(7) +.SH "HISTORY" +.IX Header "HISTORY" +The functions described here were added in OpenSSL 3.0. +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright 2020\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the \*(L"License\*(R"). 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 +<https://www.openssl.org/source/license.html>. |