doc/libstdcrypto/index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>skalibs: the stdcrypto library interface</title>
    <meta name="Description" content="skalibs: the stdcrypto library interface" />
    <meta name="Keywords" content="skalibs stdcrypto libstdcrypto library interface" />
    <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="../libskarnet.html">libskarnet</a><br />
<a href="../index.html">skalibs</a><br />
<a href="http://skarnet.org/software/">Software</a><br />
<a href="http://skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>stdcrypto</tt> library interface </h1>

<p>
<tt>stdcrypto</tt> is a small collection of standard,
public-domain cryptographic primitives. Currently, the following
operations are provided:
</p>

<ul>
  <li> rc4 </li>
  <li> md5 </li>
  <li> sha1 </li>
  <li> sha256 </li>
  <li> sha512 </li>
</ul>

<h2> Compiling </h2>

<ul>
 <li> Use <tt>#include &lt;skalibs/stdcrypto.h&gt;</tt> </li>
</ul>

<h2> Programming </h2>

<p>
 You should refer to the <tt>skalibs/stdcrypto.h</tt> header and included headers
for the exact function prototypes.
</p>

<h3> <a name="rc4" />
RC4 </h3>

<pre>
  RC4Schedule ctx ;
  unsigned char const *key ;
  unsigned int keylen ;
  unsigned char const *in ;
  unsigned char *out ;
  unsigned int len ;

  rc4_init(&amp;ctx, key, keylen) ;
  rc4(&amp;ctx, in, out, len) ;
</pre>

<ul>
  <li> <tt>rc4_init()</tt> initializes a RC4Schedule structure with a key <em>key</em>,
of length <em>keylen</em>. It then computes and throws away the first <tt>RC4_THROWAWAY</tt>
bytes, usually 100 </li>
  <li> <tt>rc4()</tt> encrypts <em>len</em> bytes of <em>in</em> with the RC4 flow, and
stores the results into <em>out</em> </li>
</ul>

<h3> <a name="md5" />
MD5 </h3>

<pre>
  MD5Schedule ctx ;
  char const *message ;
  unsigned int messagelen ;
  char digest[16] ;

  md5_init(&amp;ctx) ;
  md5_update(&amp;ctx, message, messagelen) ;
  md5_final(&amp;ctx, digest) ;
</pre>    

<ul>
  <li> <tt>md5_init()</tt> prepares a MD5Schedule structure for computation </li>
  <li> <tt>md5_update()</tt> adds <em>message</em> to the message to be digested </li>
  <li> <tt>md5_final()</tt> computes the digest </li>
</ul>

<h3> <a name="sha1"></a>
SHA1 </h3>

<pre>
  SHA1Schedule ctx ;
  char const *message ;
  unsigned int messagelen ;
  unsigned char digest[20] ;

  sha1_init(&amp;ctx) ;
  sha1_update(&amp;ctx, message, messagelen) ;
  sha1_final(&amp;ctx, digest) ;
</pre>

<ul>
  <li> <tt>sha1_init()</tt> prepares a SHA1Schedule structure for computation </li>
  <li> <tt>sha1_update()</tt> adds <em>message</em> to the message to be digested </li>
  <li> <tt>sha1_final()</tt> computes the digest </li>
</ul>

<h3> <a name="sha256"></a>
SHA256 </h3>

<pre>
  SHA256Schedule ctx ;
  char const *message ;
  unsigned int messagelen ;
  char digest[32] ;

  sha256_init(&amp;ctx) ;
  sha256_update(&amp;ctx, message, messagelen) ;
  sha256_final(&amp;ctx, digest) ;
</pre>

<ul>
  <li> <tt>sha256_init()</tt> prepares a SHA256Schedule structure for computation </li>
  <li> <tt>sha256_update()</tt> adds <em>message</em> to the message to be digested </li>
  <li> <tt>sha256_final()</tt> computes the digest </li>
</ul>

<h3> <a name="sha512"></a>
SHA512 </h3>

<pre>
  SHA512Schedule ctx ;
  char const *message ;
  unsigned int messagelen ;
  char digest[64] ;

  sha512_init(&amp;ctx) ;
  sha512_update(&amp;ctx, message, messagelen) ;
  sha512_final(&amp;ctx, digest) ;
</pre>

<ul>
  <li> <tt>sha512_init()</tt> prepares a SHA512Schedule structure for computation </li>
  <li> <tt>sha512_update()</tt> adds <em>message</em> to the message to be digested </li>
  <li> <tt>sha512_final()</tt> computes the digest </li>
</ul>

</body>
</html>