FKME FLAM Key Management Exit (FKME) Service Provider Interface (SPI)

General information

Below you can find some general information about these interface.

# Trademarks

    Below, you can find all trademarks or registered trademarks of limes
    datentechnik (R) gmbh. These trademarked terms are marked with the
    appropriate symbol ((R) or (TM)), indicating registered or common law
    trademarks owned by limes datentechnik (R) gmbh at the time this
    information was published. The following terms are trademarks of
    limes datentechnik (R) gmbh in Germany, other countries, or both:

      LIMES(R)     - Short company name of the owner of this document
      limes datentechnik(R) - Company name of the owner of this document
      FLCL(R)      - Frankenstein Limes Command Line
      FLCC(R)      - Frankenstein Limes Control Center
      FLAM(R)      - Frankenstein Limes Access Method
      FLUC(R)      - Frankenstein Limes Universal Converter
      FLIES(R)     - Frankenstein Limes Integrated Extended Security
      FKMS(R)      - Frankenstein Key Management System
      FKME(R)      - Frankenstein Key Management Extension/Exit
      FLAMFILE(R)  - A file based on FLAM syntax
      CLE/P(R)     - Command line Executer/Parser

# License terms

    The license terms for all software components owned by limes datentechnik gmbh(R)
    can be found in LICENSE(.txt) in the installation folder doc/txt or in the
    partitioned dataset HLQ.FLAM.DOCTXT. Additional license information for
    external libraries used by this software can be found in ABOUT(.txt).
    The replacement of external libraries (LGPL) is described following the
    changelog in the file README(.txt). All license terms of the external
    libraries are included as files (LICxxxxx(.txt)) in doc/txt folder
    or in HLQ.FLAM.DOCTXT partitioned dataset.

    All old FLAM components till version 4 are completely owned by limes
    datentechnik gmbh (R). Only on Linux systems the glibc is used in
    unmodified form as prerequisite (part of the operating system, not part
    of the distribution) based on the LGPL license. The old FLAM4 components
    don't provide additional about and version commands or functions.

    The service provider interfaces (exits, extensions) of FLAM are owned
    completely by limes datantechnik gmbh(R) and provided to our users for
    individual extension to this software. The driver is conforming to this
    license terms but LIMES(R) is not responsible for such individual
    implementations which are not part of our distributen. Our own
    implementations against these SPIs (e.g. FAVECAV, PKCS#11, IBM-CCA/ICSF)
    are in sync with the stated license terms here.

    A lot of this information is generated in the package build process
    and can be requested over the corresponding built-in commands of our
    utilities or the corresponding functions of the APIs. To request
    the current valid state, please use the command or functions below
    (there are more APIs with analog functions available):

    ------------------------------------------------------------------------
     COMMAND            API 1      API 2      ...   API n
     > &{pgm} license   fcblic()   FCRLIC()   ...   fliconv_license()
     > &{pgm} about     fcbabo()   FCRABO()   ...   fliconv_about()
     > &{pgm} version   fcbvsn()   FCRVSN()   ...   fliconv_version()
    ------------------------------------------------------------------------

    The about and version information are also added as appendix to the
    manual's provided by limes datentechnik gmbh(R).

    The version information contains version, release and revision number of
    each component followed by the current build number. The versioning of
    the different components is independent of each other. The build number
    must be the same for each component and must correspond to the build
    number of the installation package. If the build number is not identical
    for all compiled and linked components, then the installation is wrong.

# Replace external libraries

    External libraries under LGPL are linked in dynamic form and can be
    replaced by another dynamic library which fulfills the corresponding
    interface. This can be done by deleting the library in the program
    directory if the replacement library is located in the library path
    or by overwriting the library in the program directory. The list below
    contains all LGPL based libraries used by FL5 per platform.

    glibc on Linux:
       This library is part of the operating system and a prerequisite to
       run the FL5 infrastructure on Linux systems. FL5 can be used with
       different version and distributions of linux. Replacement of glibc
       will be done by the normal update process of your linux installation.

    libfuse on Unix:
       This library is part of the operating system and a prerequisite to
       run the FL5 file systems on Linux systems. The file systems are
       delivered for libfuse version 2 and 3. Replacement of libfuse
       will be done by the normal update process of your Unix installation.

    libssh:
       The libssh library can be found in the installation directory. A
       customized version is used that is not compatible with the official
       libssh releases. The modified libssh source can be found at:
       https://github.com/limes-datentechnik-gmbh/libssh

    Attention: In all cases we recommend using the tested and supported
    libraries from this package. If a supplied library is replaced, the
    license terms and warranty of the new library become valid, replacing
    the license and warranty of the replaced library.