root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/EVP_sm3.pod

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

61 lines
1.2 KiB
Plaintext
Raw Normal View History

SM3: restructure to EVP internal and update doc to right location Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4616)
2017-10-30 17:59:00 +08:00
=pod
=head1 NAME
EVP_sm3
- SM3 for EVP
=head1 SYNOPSIS
#include <openssl/evp.h>
Add semicolon at the end of the function prototypes Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/7041)
2018-08-24 20:38:04 +08:00
const EVP_MD *EVP_sm3(void);
SM3: restructure to EVP internal and update doc to right location Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4616)
2017-10-30 17:59:00 +08:00
=head1 DESCRIPTION
SM3 is a cryptographic hash function with a 256-bit output, defined in GB/T
32905-2016.
=over 4
=item EVP_sm3()
The SM3 hash function.
=back
Add provider pre-fetching documentation Clearly document that implicit fetching is slower when using providers, and explain prefetching. Added to crypto.pod and migration_guide.pod links to it. Add a link to EVP_default_properties_enable_fips() in crypto.pod. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20354)
2023-02-22 08:11:33 +08:00
=head1 NOTES
Developers should be aware of the negative performance implications of
calling this function multiple times and should consider using
Reference the non-"legacy" provider names directly from EVP_md5(3) &c. Earlier today, it took me five manuals! to find what on earth the "Performance"/"EVP_MD_fetch(3)" crosslinks actually mean: EVP_sha1(3) crypto(7) EVP_MD_fetch(3) (but not there! don't read that!) OSSL_PROVIDER-default(7) EVP_MD-SHA1(7) If, instead, EVP_sha1(3) referenced EVP_MD-SHA1(7) at /all/, which it should do, since it's supposed to be what you're replacing it with, but it doesn't actually say that, maybe people would use it. I know I didn't because it's basically just deadass buried As found by git grep -l 'and should consider using' Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22420)
2023-10-18 21:35:55 +08:00
L<EVP_MD_fetch(3)> with L<EVP_MD-SM3(7)> instead.
Add provider pre-fetching documentation Clearly document that implicit fetching is slower when using providers, and explain prefetching. Added to crypto.pod and migration_guide.pod links to it. Add a link to EVP_default_properties_enable_fips() in crypto.pod. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20354)
2023-02-22 08:11:33 +08:00
See L<crypto(7)/Performance> for further information.
SM3: restructure to EVP internal and update doc to right location Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4616)
2017-10-30 17:59:00 +08:00
=head1 RETURN VALUES
These functions return a B<EVP_MD> structure that contains the
doc: replace "symmetric cipher" phrase in EVP_MD manpages CLA: trivial Reviewed-by: Ben Kaduk <kaduk@mit.edu> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/18169)
2022-04-25 16:51:00 +08:00
implementation of the message digest. See L<EVP_MD_meth_new(3)> for
SM3: restructure to EVP internal and update doc to right location Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4616)
2017-10-30 17:59:00 +08:00
details of the B<EVP_MD> structure.
=head1 CONFORMING TO
GB/T 32905-2016 and GM/T 0004-2012.
=head1 SEE ALSO
L<evp(7)>,
L<EVP_DigestInit(3)>
=head1 COPYRIGHT
Copyright year updates Reviewed-by: Richard Levitte <levitte@openssl.org> Release: yes
2023-09-07 16:59:15 +08:00
Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.
SM3: restructure to EVP internal and update doc to right location Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4616)
2017-10-30 17:59:00 +08:00
Copyright 2017 Ribose Inc. All Rights Reserved.
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
SM3: restructure to EVP internal and update doc to right location Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4616)
2017-10-30 17:59:00 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut