"Fossies" - the Fresh Open Source Software Archive

Member "tin-2.4.5/libcanlock/README" (25 Jan 2018, 2638 Bytes) of package /linux/misc/tin-2.4.5.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "README": 2.4.2_vs_2.4.3.

    1 
    2 libcanlock
    3 ==========
    4 A library for creating and verifying RFC 8315 Netnews Cancel-Locks.
    5 This implementation uses the recommended algorithm from Section 4 with HMAC
    6 based on the same hash function as <scheme>.
    7 
    8 
    9 1) General
   10 libcanlock is a standalone implementation without external dependencies.
   11 If your program already uses a library that contains functions for hash and
   12 base64 algorithms (e.g. OpenSSL), it is recommended that you use them instead
   13 (to avoid code duplication).
   14 
   15 
   16 2) System requirements
   17 - POSIX.1-2001 compliant operating system
   18 - C99 compiler with 'int' data type of at least 32 bit width
   19 
   20 Note:
   21 A POSIX style operating system is required only for the build system and the
   22 test-suite.
   23 The code of the library and CLI utility is intended to be portable C99 (with the
   24 exception that 16 bit platforms are not supported).
   25 
   26 
   27 3) API
   28 Since version 3 there is a new API available (hash algorithm independent).
   29 Man pages for this API are installed together with the library.
   30 
   31 Anything that is not documented should be considered as internal and not
   32 part of the API. There is no portable way to hide all the internal stuff
   33 completely, but expect that a future version may no longer export it without
   34 notice.
   35 
   36 
   37 4) Backward compatibility
   38 The old API from version 2 is still emulated, but it is now deprecated and
   39 undocumented.
   40 
   41 Including the header file from the new location, recompile and relink should
   42 be sufficient to port an existing application to version 3 of the library.
   43 It is also possible to install both version 2 and version 3 of the library
   44 in parallel.
   45 
   46 
   47 5) Versioning scheme
   48 With version 3 the release version scheme has changed.
   49 Now the release version contains 3 numbers "x.y.z":
   50 
   51 - Major (x)
   52   The major number is incremented for every API/ABI change that is not backward
   53   compatible.
   54 - Minor (y)
   55   The minor number is incremented for API/ABI extensions that are backward
   56   compatible.
   57 - Patch (z)
   58   The patch number is incremented for changes that don't change the API/ABI.
   59 
   60 In other words:
   61 Releases with the same major and minor numbers are drop-in replacements.
   62 Up- and downgrades between such versions are possible without touching
   63 programs that use the library.
   64 Releases with the same major, but different minor numbers are backward,
   65 but not forward compatible. Upgrades are possible, downgrades can break
   66 programs that use the library.
   67 Releases with different major numbers require changes in all programs that
   68 use the library.
   69 
   70 
   71 canlock
   72 =======
   73 Since version 3 the command line utility "canlock" is available as frontend.
   74 The utility and a man page for it are installed together with the library.
   75 
   76 
   77 EOF