avr-crypto-lib/doc/acl-guide.texi

71 lines
1.7 KiB
Plaintext

\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename acl-manual.info
@settitle AVR/ARM-Crypto-Lib Manual 1.0
@c %**end of header
@copying
This is a short example of a complete Texinfo file.
Copyright © 2011 Daniel Otte (@email{daniel.otte@@rub.de})
@end copying
@titlepage
@title AVR/ARM-Crypto-Lib Manual 1.0
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@c Output the table of the contents at the beginning.
@contents
@ifnottex
@node Top
@top GNU Sample
@insertcopying
@end ifnottex
@chapter About
This documentation is a guide to the AVR-Crypto-Lib and ARM-Crypto-Lib.
Instead of documenting the full API and each function we choose the approach
of documenting the structure of the API so you know what to do when you want
to use the library.
@chapter Generic stuff
@section File organisation
@section Build process
@section Testing system
@section Sizes in bits and bytes
Working with cryptographic functions involves working with different
lengths. Some times you want to know it in bits, sometimes in bytes and another
time in words (how long a word is must be defined by the context).
To reduce confusion, frustration and to avoid bugs we suffix a length
parameter with either _b, _B or _w depending on the meaning.
_b means in bits and _B means in bytes (big b big word) and _w meaning words.
@chapter Symmetric primitives
@include acl_blockciphers.texi
@section Modes of operation
@include acl_streamciphers.texi
@include acl_hashes.texi
@section MAC functions
@section Pseudo random number generators (PRNGs)
@chapter Encodings
@section Base64
@section ASN.1
@chapter Big integer functions
@chapter Asymmetric Primitives
@section DSA
@section RSA
@section El-Gamal
@section MQQ
@bye