\hypertarget{sha224_8h}{
\section{include/beecrypt/sha224.h File Reference}
\label{sha224_8h}\index{include/beecrypt/sha224.h@{include/beecrypt/sha224.h}}
}


SHA-\/224 hash function, headers.  


{\ttfamily \#include \char`\"{}beecrypt/beecrypt.h\char`\"{}}\par
Include dependency graph for sha224.h:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=210pt]{sha224_8h__incl}
\end{center}
\end{figure}
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structsha224Param}{sha224Param}
\begin{DoxyCompactList}\small\item\em Holds all the parameters necessary for the SHA-\/224 algorithm. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{sha224_8h_a1138fa94075756c2a9422cdfb4100f11}{sha224Process} (\hyperlink{structsha224Param}{sha224Param} $\ast$sp)
\begin{DoxyCompactList}\small\item\em This function performs the core of the SHA-\/224 hash algorithm; it processes a block of 64 bytes. \item\end{DoxyCompactList}\item 
int \hyperlink{sha224_8h_af0b8d4bdd5bd80e7147414b11b29b1a1}{sha224Reset} (\hyperlink{structsha224Param}{sha224Param} $\ast$sp)
\begin{DoxyCompactList}\small\item\em This function resets the parameter block so that it's ready for a new hash. \item\end{DoxyCompactList}\item 
int \hyperlink{sha224_8h_ab812639b90f040f25bb4c04e1d6094dd}{sha224Update} (\hyperlink{structsha224Param}{sha224Param} $\ast$sp, const \hyperlink{api_8h_ab8ef12fab634c171394422d0ee8baf94}{byte} $\ast$data, size\_\-t size)
\begin{DoxyCompactList}\small\item\em This function should be used to pass successive blocks of data to be hashed. \item\end{DoxyCompactList}\item 
int \hyperlink{sha224_8h_a976161ffed4263e047da4e2a780a95b0}{sha224Digest} (\hyperlink{structsha224Param}{sha224Param} $\ast$sp, \hyperlink{api_8h_ab8ef12fab634c171394422d0ee8baf94}{byte} $\ast$digest)
\begin{DoxyCompactList}\small\item\em This function finishes the current hash computation and copies the digest value into {\itshape digest\/}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Variables}
\begin{DoxyCompactItemize}
\item 
const \hyperlink{structhashFunction}{hashFunction} \hyperlink{sha224_8h_a4350bd4392eb85e0fa9d1fb9f8bf79db}{sha224}
\begin{DoxyCompactList}\small\item\em Holds the full API description of the SHA-\/224 algorithm. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
SHA-\/224 hash function, headers. \begin{DoxyAuthor}{Author}
Bob Deblier $<$\href{mailto:bob.deblier@telenet.be}{\tt bob.deblier@telenet.be}$>$ 
\end{DoxyAuthor}


\subsection{Function Documentation}
\hypertarget{sha224_8h_a976161ffed4263e047da4e2a780a95b0}{
\index{sha224.h@{sha224.h}!sha224Digest@{sha224Digest}}
\index{sha224Digest@{sha224Digest}!sha224.h@{sha224.h}}
\subsubsection[{sha224Digest}]{\setlength{\rightskip}{0pt plus 5cm}int sha224Digest (
\begin{DoxyParamCaption}
\item[{{\bf sha224Param} $\ast$}]{sp, }
\item[{{\bf byte} $\ast$}]{digest}
\end{DoxyParamCaption}
)}}
\label{sha224_8h_a976161ffed4263e047da4e2a780a95b0}


This function finishes the current hash computation and copies the digest value into {\itshape digest\/}. 


\begin{DoxyParams}{Parameters}
{\em sp} & The hash function's parameter block. \\
\hline
{\em digest} & The place to store the 32-\/byte digest. \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em 0} & on success. \\
\hline
\end{DoxyRetVals}
\hypertarget{sha224_8h_a1138fa94075756c2a9422cdfb4100f11}{
\index{sha224.h@{sha224.h}!sha224Process@{sha224Process}}
\index{sha224Process@{sha224Process}!sha224.h@{sha224.h}}
\subsubsection[{sha224Process}]{\setlength{\rightskip}{0pt plus 5cm}void sha224Process (
\begin{DoxyParamCaption}
\item[{{\bf sha224Param} $\ast$}]{sp}
\end{DoxyParamCaption}
)}}
\label{sha224_8h_a1138fa94075756c2a9422cdfb4100f11}


This function performs the core of the SHA-\/224 hash algorithm; it processes a block of 64 bytes. 


\begin{DoxyParams}{Parameters}
{\em sp} & The hash function's parameter block. \\
\hline
\end{DoxyParams}
\hypertarget{sha224_8h_af0b8d4bdd5bd80e7147414b11b29b1a1}{
\index{sha224.h@{sha224.h}!sha224Reset@{sha224Reset}}
\index{sha224Reset@{sha224Reset}!sha224.h@{sha224.h}}
\subsubsection[{sha224Reset}]{\setlength{\rightskip}{0pt plus 5cm}int sha224Reset (
\begin{DoxyParamCaption}
\item[{{\bf sha224Param} $\ast$}]{sp}
\end{DoxyParamCaption}
)}}
\label{sha224_8h_af0b8d4bdd5bd80e7147414b11b29b1a1}


This function resets the parameter block so that it's ready for a new hash. 


\begin{DoxyParams}{Parameters}
{\em sp} & The hash function's parameter block. \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em 0} & on success. \\
\hline
\end{DoxyRetVals}
\hypertarget{sha224_8h_ab812639b90f040f25bb4c04e1d6094dd}{
\index{sha224.h@{sha224.h}!sha224Update@{sha224Update}}
\index{sha224Update@{sha224Update}!sha224.h@{sha224.h}}
\subsubsection[{sha224Update}]{\setlength{\rightskip}{0pt plus 5cm}int sha224Update (
\begin{DoxyParamCaption}
\item[{{\bf sha224Param} $\ast$}]{sp, }
\item[{const {\bf byte} $\ast$}]{data, }
\item[{size\_\-t}]{size}
\end{DoxyParamCaption}
)}}
\label{sha224_8h_ab812639b90f040f25bb4c04e1d6094dd}


This function should be used to pass successive blocks of data to be hashed. 


\begin{DoxyParams}{Parameters}
{\em sp} & The hash function's parameter block. \\
\hline
{\em data} & \\
\hline
{\em size} & \\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em 0} & on success. \\
\hline
\end{DoxyRetVals}


\subsection{Variable Documentation}
\hypertarget{sha224_8h_a4350bd4392eb85e0fa9d1fb9f8bf79db}{
\index{sha224.h@{sha224.h}!sha224@{sha224}}
\index{sha224@{sha224}!sha224.h@{sha224.h}}
\subsubsection[{sha224}]{\setlength{\rightskip}{0pt plus 5cm}{\bf sha224}}}
\label{sha224_8h_a4350bd4392eb85e0fa9d1fb9f8bf79db}


Holds the full API description of the SHA-\/224 algorithm.