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

Update documentation

pull/484/merge
Jeffrey Walton 2017-09-22 10:14:46 -04:00
parent ced7cff64f
commit fba3fd724b
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
ppc-crypto.h
View File

@ -38,6 +38,7 @@ typedef uint64x2_p8 VectorType;
//! \param src the byte array //! \param src the byte array
//! \details ReverseByteArrayLE reverses a 16-byte array on a little endian //! \details ReverseByteArrayLE reverses a 16-byte array on a little endian
//! system. It does nothing on a big endian system. //! system. It does nothing on a big endian system.
//! \since Crypto++ 6.0
inline void ReverseByteArrayLE(byte src[16]) inline void ReverseByteArrayLE(byte src[16])
{ {
#if defined(CRYPTOPP_XLC_VERSION) && defined(IS_LITTLE_ENDIAN) #if defined(CRYPTOPP_XLC_VERSION) && defined(IS_LITTLE_ENDIAN)
@ -52,7 +53,9 @@ inline void ReverseByteArrayLE(byte src[16])
//! \brief Reverse a vector //! \brief Reverse a vector
//! \tparam T a vector type //! \tparam T a vector type
//! \param src the vector //! \param src the vector
//! \details Reverse endian swaps the bytes in a vector //! \details Reverse() endian swaps the bytes in a vector
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
template <class T> template <class T>
inline T Reverse(const T& src) inline T Reverse(const T& src)
{ {
@ -65,7 +68,9 @@ inline T Reverse(const T& src)
//! \param src the byte array //! \param src the byte array
//! \details Loads a vector in big endian format from a byte array. //! \details Loads a vector in big endian format from a byte array.
//! VectorLoadBE will swap endianess on little endian systems. //! VectorLoadBE will swap endianess on little endian systems.
//! \note VectorLoadBE does not require an aligned array. //! \note VectorLoadBE() does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoadBE(const uint8_t src[16]) inline VectorType VectorLoadBE(const uint8_t src[16])
{ {
#if defined(CRYPTOPP_XLC_VERSION) #if defined(CRYPTOPP_XLC_VERSION)
@ -85,6 +90,8 @@ inline VectorType VectorLoadBE(const uint8_t src[16])
//! \details Loads a vector in big endian format from a byte array. //! \details Loads a vector in big endian format from a byte array.
//! VectorLoadBE will swap endianess on little endian systems. //! VectorLoadBE will swap endianess on little endian systems.
//! \note VectorLoadBE does not require an aligned array. //! \note VectorLoadBE does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoadBE(int off, const uint8_t src[16]) inline VectorType VectorLoadBE(int off, const uint8_t src[16])
{ {
#if defined(CRYPTOPP_XLC_VERSION) #if defined(CRYPTOPP_XLC_VERSION)
@ -105,6 +112,8 @@ inline VectorType VectorLoadBE(int off, const uint8_t src[16])
//! \details Stores a vector in big endian format to a byte array. //! \details Stores a vector in big endian format to a byte array.
//! VectorStoreBE will swap endianess on little endian systems. //! VectorStoreBE will swap endianess on little endian systems.
//! \note VectorStoreBE does not require an aligned array. //! \note VectorStoreBE does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
template <class T> template <class T>
inline void VectorStoreBE(const T& src, uint8_t dest[16]) inline void VectorStoreBE(const T& src, uint8_t dest[16])
{ {
@ -126,6 +135,8 @@ inline void VectorStoreBE(const T& src, uint8_t dest[16])
//! \details Loads a vector in big endian format from a byte array. //! \details Loads a vector in big endian format from a byte array.
//! VectorLoad will swap endianess on little endian systems. //! VectorLoad will swap endianess on little endian systems.
//! \note VectorLoad does not require an aligned array. //! \note VectorLoad does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoad(const byte src[16]) inline VectorType VectorLoad(const byte src[16])
{ {
return (VectorType)VectorLoadBE((uint8_t*)src); return (VectorType)VectorLoadBE((uint8_t*)src);
@ -137,6 +148,8 @@ inline VectorType VectorLoad(const byte src[16])
//! \details Loads a vector in big endian format from a byte array. //! \details Loads a vector in big endian format from a byte array.
//! VectorLoad will swap endianess on little endian systems. //! VectorLoad will swap endianess on little endian systems.
//! \note VectorLoad does not require an aligned array. //! \note VectorLoad does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoad(int off, const byte src[16]) inline VectorType VectorLoad(int off, const byte src[16])
{ {
return (VectorType)VectorLoadBE(off, (uint8_t*)src); return (VectorType)VectorLoadBE(off, (uint8_t*)src);
@ -147,6 +160,8 @@ inline VectorType VectorLoad(int off, const byte src[16])
//! \details Loads a vector from a byte array. //! \details Loads a vector from a byte array.
//! VectorLoadKey does not swap endianess on little endian systems. //! VectorLoadKey does not swap endianess on little endian systems.
//! \note VectorLoadKey does not require an aligned array. //! \note VectorLoadKey does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoadKey(const byte src[16]) inline VectorType VectorLoadKey(const byte src[16])
{ {
#if defined(CRYPTOPP_XLC_VERSION) #if defined(CRYPTOPP_XLC_VERSION)
@ -161,6 +176,8 @@ inline VectorType VectorLoadKey(const byte src[16])
//! \details Loads a vector from a 32-bit word array. //! \details Loads a vector from a 32-bit word array.
//! VectorLoadKey does not swap endianess on little endian systems. //! VectorLoadKey does not swap endianess on little endian systems.
//! \note VectorLoadKey does not require an aligned array. //! \note VectorLoadKey does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoadKey(const word32 src[4]) inline VectorType VectorLoadKey(const word32 src[4])
{ {
#if defined(CRYPTOPP_XLC_VERSION) #if defined(CRYPTOPP_XLC_VERSION)
@ -176,6 +193,8 @@ inline VectorType VectorLoadKey(const word32 src[4])
//! \details Loads a vector from a byte array. //! \details Loads a vector from a byte array.
//! VectorLoadKey does not swap endianess on little endian systems. //! VectorLoadKey does not swap endianess on little endian systems.
//! \note VectorLoadKey does not require an aligned array. //! \note VectorLoadKey does not require an aligned array.
//! \sa Reverse(), VectorLoadBE(), VectorLoad(), VectorLoadKey()
//! \since Crypto++ 6.0
inline VectorType VectorLoadKey(int off, const byte src[16]) inline VectorType VectorLoadKey(int off, const byte src[16])
{ {
#if defined(CRYPTOPP_XLC_VERSION) #if defined(CRYPTOPP_XLC_VERSION)
@ -192,6 +211,7 @@ inline VectorType VectorLoadKey(int off, const byte src[16])
//! \details Stores a vector in big endian format to a byte array. //! \details Stores a vector in big endian format to a byte array.
//! VectorStore will swap endianess on little endian systems. //! VectorStore will swap endianess on little endian systems.
//! \note VectorStoreBE does not require an aligned array. //! \note VectorStoreBE does not require an aligned array.
//! \since Crypto++ 6.0
template<class T> template<class T>
inline void VectorStore(const T& src, byte dest[16]) inline void VectorStore(const T& src, byte dest[16])
{ {
@ -207,6 +227,7 @@ inline void VectorStore(const T& src, byte dest[16])
//! \details VectorPermute returns a new vector from vec1 and vec2 //! \details VectorPermute returns a new vector from vec1 and vec2
//! based on mask. mask is an uint8x16_p8 type vector. The return //! based on mask. mask is an uint8x16_p8 type vector. The return
//! vector is the same type as vec1. //! vector is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorPermute(const T1& vec1, const T1& vec2, const T2& mask) inline T1 VectorPermute(const T1& vec1, const T1& vec2, const T2& mask)
{ {
@ -220,6 +241,7 @@ inline T1 VectorPermute(const T1& vec1, const T1& vec2, const T2& mask)
//! \param vec2 the second vector //! \param vec2 the second vector
//! \details VectorXor returns a new vector from vec1 and vec2. The return //! \details VectorXor returns a new vector from vec1 and vec2. The return
//! vector is the same type as vec1. //! vector is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorXor(const T1& vec1, const T2& vec2) inline T1 VectorXor(const T1& vec1, const T2& vec2)
{ {
@ -234,6 +256,7 @@ inline T1 VectorXor(const T1& vec1, const T2& vec2)
//! \details VectorAdd returns a new vector from vec1 and vec2. //! \details VectorAdd returns a new vector from vec1 and vec2.
//! vec2 is cast to the same type as vec1. The return vector //! vec2 is cast to the same type as vec1. The return vector
//! is the same type as vec1. //! is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorAdd(const T1& vec1, const T2& vec2) inline T1 VectorAdd(const T1& vec1, const T2& vec2)
{ {
@ -251,6 +274,7 @@ inline T1 VectorAdd(const T1& vec1, const T2& vec2)
//! \note VectorShiftLeft handles the difference between big endian //! \note VectorShiftLeft handles the difference between big endian
//! and little endian internally. Call the function as if on a big //! and little endian internally. Call the function as if on a big
//! endian machine. //! endian machine.
//! \since Crypto++ 6.0
template <int C, class T1, class T2> template <int C, class T1, class T2>
inline T1 VectorShiftLeft(const T1& vec1, const T2& vec2) inline T1 VectorShiftLeft(const T1& vec1, const T2& vec2)
{ {
@ -268,6 +292,7 @@ inline T1 VectorShiftLeft(const T1& vec1, const T2& vec2)
//! \param key the subkey vector //! \param key the subkey vector
//! \details VectorEncrypt performs one round of AES encryption of state //! \details VectorEncrypt performs one round of AES encryption of state
//! using subkey key. The return vector is the same type as vec1. //! using subkey key. The return vector is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorEncrypt(const T1& state, const T2& key) inline T1 VectorEncrypt(const T1& state, const T2& key)
{ {
@ -287,6 +312,7 @@ inline T1 VectorEncrypt(const T1& state, const T2& key)
//! \param key the subkey vector //! \param key the subkey vector
//! \details VectorEncryptLast performs the final round of AES encryption //! \details VectorEncryptLast performs the final round of AES encryption
//! of state using subkey key. The return vector is the same type as vec1. //! of state using subkey key. The return vector is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorEncryptLast(const T1& state, const T2& key) inline T1 VectorEncryptLast(const T1& state, const T2& key)
{ {
@ -306,6 +332,7 @@ inline T1 VectorEncryptLast(const T1& state, const T2& key)
//! \param key the subkey vector //! \param key the subkey vector
//! \details VectorDecrypt performs one round of AES decryption of state //! \details VectorDecrypt performs one round of AES decryption of state
//! using subkey key. The return vector is the same type as vec1. //! using subkey key. The return vector is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorDecrypt(const T1& state, const T2& key) inline T1 VectorDecrypt(const T1& state, const T2& key)
{ {
@ -325,6 +352,7 @@ inline T1 VectorDecrypt(const T1& state, const T2& key)
//! \param key the subkey vector //! \param key the subkey vector
//! \details VectorDecryptLast performs the final round of AES decryption //! \details VectorDecryptLast performs the final round of AES decryption
//! of state using subkey key. The return vector is the same type as vec1. //! of state using subkey key. The return vector is the same type as vec1.
//! \since Crypto++ 6.0
template <class T1, class T2> template <class T1, class T2>
inline T1 VectorDecryptLast(const T1& state, const T2& key) inline T1 VectorDecryptLast(const T1& state, const T2& key)
{ {
@ -344,6 +372,7 @@ inline T1 VectorDecryptLast(const T1& state, const T2& key)
//! \param vec the block to transform //! \param vec the block to transform
//! \details VectorSHA512 selects sigma0, sigma1, Sigma0, Sigma1 based on //! \details VectorSHA512 selects sigma0, sigma1, Sigma0, Sigma1 based on
//! func and subfunc. The return vector is the same type as vec. //! func and subfunc. The return vector is the same type as vec.
//! \since Crypto++ 6.0
template <int func, int subfunc, class T> template <int func, int subfunc, class T>
inline T VectorSHA512(const T& vec) inline T VectorSHA512(const T& vec)
{ {
@ -363,6 +392,7 @@ inline T VectorSHA512(const T& vec)
//! \param vec the block to transform //! \param vec the block to transform
//! \details VectorSHA256 selects sigma0, sigma1, Sigma0, Sigma1 based on //! \details VectorSHA256 selects sigma0, sigma1, Sigma0, Sigma1 based on
//! func and subfunc. The return vector is the same type as vec. //! func and subfunc. The return vector is the same type as vec.
//! \since Crypto++ 6.0
template <int func, int subfunc, class T> template <int func, int subfunc, class T>
inline T VectorSHA256(const T& vec) inline T VectorSHA256(const T& vec)
{ {