diff options
author | Jeffrey Walton <noloader@gmail.com> | 2019-04-27 14:40:53 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2019-04-27 14:40:53 -0400 |
commit | d451751eb269ff1345c9937107788d678c70e36f (patch) | |
tree | 2fb545649220d63756dad4f29801bb7f8f1f08eb /skipjack.h | |
parent | cdaac6b8446c1480d37e32bc864bd8215e5e7c90 (diff) | |
download | cryptopp-git-d451751eb269ff1345c9937107788d678c70e36f.tar.gz |
Update SKIPJACK documentation (GH #824)
Diffstat (limited to 'skipjack.h')
-rw-r--r-- | skipjack.h | 13 |
1 files changed, 12 insertions, 1 deletions
@@ -2,6 +2,12 @@ /// \file skipjack.h
/// \brief Classes for the SKIPJACK block cipher
+/// \details The Crypto++ implementation conforms to SKIPJACK and KEA
+/// Algorithm Specifications published by NIST in May 1998. The library passes
+/// known answer tests available in NIST SP800-17, Table 6, pp. 140-42.
+/// \sa <a href ="http://csrc.nist.gov/encryption/skipjack/skipjack.pdf">SKIPJACK
+/// and KEA Algorithm Specifications</a> (May 1998), <a
+/// href="http://www.cryptopp.com/wiki/SKIPJACK">SKIPJACK</a> on the Crypto++ wiki
#ifndef CRYPTOPP_SKIPJACK_H
#define CRYPTOPP_SKIPJACK_H
@@ -18,7 +24,12 @@ struct SKIPJACK_Info : public FixedBlockSize<8>, public FixedKeyLength<10> };
/// \brief SKIPJACK block cipher
-/// \sa <a href="http://www.cryptopp.com/wiki/SKIPJACK">SKIPJACK</a>
+/// \details The Crypto++ implementation conforms to SKIPJACK and KEA
+/// Algorithm Specifications published by NIST in May 1998. The library passes
+/// known answer tests available in NIST SP800-17, Table 6, pp. 140-42.
+/// \sa <a href ="http://csrc.nist.gov/encryption/skipjack/skipjack.pdf">SKIPJACK
+/// and KEA Algorithm Specifications</a> (May 1998), <a
+/// href="http://www.cryptopp.com/wiki/SKIPJACK">SKIPJACK</a> on the Crypto++ wiki
class SKIPJACK : public SKIPJACK_Info, public BlockCipherDocumentation
{
/// \brief SKIPJACK block cipher default operation
|