arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

pull/755/head
Jeffrey Walton 2018-11-27 06:08:51 -05:00
parent 9ddd6dc93c
commit d41085e907
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
darn.h
View File

@ -11,6 +11,8 @@
/// \file darn.h /// \file darn.h
/// \brief Classes for DARN RNG /// \brief Classes for DARN RNG
/// \sa <A HREF="https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0">Power
/// ISA Version 3.0B</A>
/// \since Crypto++ 8.0 /// \since Crypto++ 8.0
#ifndef CRYPTOPP_DARN_H #ifndef CRYPTOPP_DARN_H
@ -22,8 +24,6 @@ NAMESPACE_BEGIN(CryptoPP)
/// \brief Exception thrown when a DARN generator encounters /// \brief Exception thrown when a DARN generator encounters
/// a generator related error. /// a generator related error.
/// \sa <A HREF="https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0">Power
/// ISA Version 3.0B</A>
/// \since Crypto++ 8.0 /// \since Crypto++ 8.0
class DARN_Err : public Exception class DARN_Err : public Exception
{ {
@ -33,12 +33,16 @@ public:
}; };
/// \brief Hardware generated random numbers using DARN instruction /// \brief Hardware generated random numbers using DARN instruction
/// \details DARN() provides access to Power9's random number generator. /// \details DARN() provides access to Power9's random number generator. The
/// Crypto++ implementation provides conditioned random numbers from the
/// generator as opposed to raw random numbers. According to Power ISA 3.0B
/// manual, a conditioned random number has been processed by hardware to
/// reduce bias. A raw random number is unconditioned noise source output.
/// \details According to Power ISA 3.0B manual, the random number generator /// \details According to Power ISA 3.0B manual, the random number generator
/// provided by this instruction is NIST SP800-90B and SP800-90C compliant to /// provided by the <tt>darn</tt> instruction is NIST SP800-90B and SP800-90C
/// the extent possible given the completeness of the standards at the time /// compliant to the extent possible given the completeness of the standards
/// the hardware is designed. The random number generator provides a minimum /// at the time the hardware is designed. The random number generator provides
/// of 0.5 bits of entropy per bit. /// a minimum of 0.5 bits of entropy per bit.
/// \par Wraps /// \par Wraps
/// darn instruction /// darn instruction
/// \sa <A HREF="https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0">Power /// \sa <A HREF="https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0">Power