readme.txt

   1 YACA - Yet Another Crypto API
   2
   3 Basic information:
   4
   5 Code Style (for now):
   6         Tabs (8-chars) + spaces;
   7         $ astyle -T8 <file>
   8
   9 Project structure:
  10         api/ - Public API (headers)
  11
  12         demos/ - Demo applications
  13         doc/ - Documentation
  14         examples/ - Usage examples
  15
  16         src/ - source
  17
  18         test/ - tests
  19
  20 General design:
  21         - All memory allocated by API should be freed with yaca_free()
  22         - Contexts and keys should be freed with yaca_ctx_free()/yaca_key_free()
  23         - Function names: yaca_<operation/object>_<function>; Ex: yaca_verify_init()
  24         - Simplified/Simple functions don't have <operation/object> part
  25         - Enums: YACA_<concept>_<value>; Ex: YACA_KEY_256BIT
  26         - Objects (context, key) end with _h
  27         - Most functions return 0 on success, negative values on error
  28
  29 Simplified API:
  30         - Is located in simple.h
  31         - Currently, to use it - some functions from crypto.h and key.h are needed
  32         - Symmetric ciphers (except for GCM) and message digests are only operations that are supported
  33         - All operations are single-shot and output is allocated by library
  34
  35 API:
  36         1) All contexts are created by appropriate init() functions
  37         2) Keys are created by generate or import functions
  38
  39 Examples:
  40         - It is possible to compile-check examples with "make" command
  41
  42 Tests:
  43         All tests are developed at security-tests repository from tizen.org, branch yaca.
  44         git clone ssh://[USER_ID]@review.tizen.org:29418/platform/core/test/security-tests -b yaca
  45         Build all tests with command: cmake -DBUILD_ALL_TESTS=OFF -DBUILD_YACA=ON; make
  46         Run all tests with command: yaca-test