doc/acl-guide.texi

   1 \input texinfo  @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename acl-manual.info
   4 @settitle AVR/ARM-Crypto-Lib Manual 1.0
   5 @c %**end of header
   6
   7 @copying
   8 This is a short example of a complete Texinfo file.
   9 Copyright © 2011 Daniel Otte (@email{daniel.otte@@rub.de})
  10 @end copying
  11
  12 @titlepage
  13 @title AVR/ARM-Crypto-Lib Manual 1.0
  14 @page
  15 @vskip 0pt plus 1filll
  16 @insertcopying
  17 @end titlepage
  18 @c Output the table of the contents at the beginning.
  19 @contents
  20 @ifnottex
  21 @node Top
  22 @top GNU Sample
  23 @insertcopying
  24 @end ifnottex
  25
  26 @chapter About
  27 This documentation is a guide to the AVR-Crypto-Lib and ARM-Crypto-Lib.
  28 Instead of documenting the full API and each function we choose the approach
  29 of documenting the structure of the API so you know what to do when you want
  30 to use the library.
  31
  32 @chapter Generic stuff
  33 @section File organisation
  34 @section Build process
  35 @section Testing system
  36 @section Sizes in bits and bytes
  37  Working with cryptographic functions involves working with different
  38  lengths. Some times you want to know it in bits, sometimes in bytes and another
  39  time in words (how long a word is must be defined by the context).
  40  To reduce confusion, frustration and to avoid bugs we suffix a length
  41  parameter with either _b, _B or _w depending on the meaning.
  42  _b means in bits and _B means in bytes (big b big word) and _w meaning words.
  43
  44 @chapter Symmetric primitives
  45
  46 @include acl_blockciphers.texi
  47
  48 @section Modes of operation
  49
  50 @include acl_streamciphers.texi
  51
  52 @include acl_hashes.texi
  53
  54 @section MAC functions
  55 @section Pseudo random number generators (PRNGs)
  56
  57 @chapter Encodings
  58 @section Base64
  59 @section ASN.1
  60
  61 @chapter Big integer functions
  62
  63 @chapter Asymmetric Primitives
  64 @section DSA
  65 @section RSA
  66 @section El-Gamal
  67 @section MQQ
  68
  69 @bye
  70