Copyright © 2001 - 2007 SILC Project
SILC Project Website
SILC Toolkit Reference Manual
Index

SILC Toolkit Reference Manual
SILC Crypto Library
    Introduction to SILC RNG
    SILC RNG Interface
    SILC Cipher API
    SILC PKCS API
    SILC Public Key API
    SILC PKCS #1 API
    SILC Hash Interface
    SILC HMAC Interface
SILC Core Library
    SILC Authentication Interface
    SILC Message Interface
    SILC Channel Interface
    SILC Command Interface
    SILC Notify Interface
    SILC Status Types
    SILC Modes
    SILC ID Interface
    SILC Argument Interface
    SILC Attributes Interface
    Packet Engine Interface
    SILC Public Key Payload Interface
SILC Key Exchange Library
    SILC SKE Interface
    SILC Connection Authentication Interface
SILC VCard Library
    SILC VCard Interface
SILC Math Library
    SILC MP Interface
    SILC Math Interface
SILC Client Library
    Using SILC Client Library Tutorial
    Arguments for command_reply Client Operation
    SilcStatus Error Arguments in command_reply Client Operation
    Arguments for notify Client Operation
    Unicode and UTF-8 Strings in Client Library
    Client Library Interface Reference
    Client Entry Interface Reference
SILC ASN.1 Library
    SILC ASN.1 Interface
    SILC BER interface
SILC HTTP Library
    SILC HTTP Server Interface
    SILC HTTP PHP Translator
SILC Utility Library
    Basic Types and Definitions
    Data Buffer Interface
    Data Buffer Format Interface
    Hash Table Interface
    Memory Allocation Interface
    Data Stack (memory pool) Interface
    Finite State Machine Interface
    Thread Interface
    Mutual Exclusion Lock Interface
    Condition Variable Interface
    Atomic Operations Interface
    Network (TCP and UDP) Interface
    Scheduler Interface
    Asynchronous Operation Interface
    Abstract Stream Interface
    Socket Stream Interface
    File Descriptor Stream Interface
    File Utility Functions
    String Utility Interface
    Snprintf Interface
    UTF-8 String Interface
    Stringprep Interface
    Utility Functions
    List Interface
    Dynamic List Interface
    MIME Interface
    Time Utility Functions
    Logging Interface
    Config File Interface
SILC Key Repository Library
    SILC SKR Interface
SILC Application Utility Library
    SILC Application Utilities
    SILC ID Cache Interface
SILC SFTP Library
    SILC SFTP Interface
    SFTP Filesystems Interface

Resource Links
SILC Project Website
SILC Protocol Documentation
SILC White Paper
SILC FAQs





SILC_STR_FUNC

NAME

    #define SILC_STR_FUNC() ...

DESCRIPTION

    SilcBuffer formatting.

    Formatting:    SILC_STR_FUNC(function, void *value, void *context)
    Unformatting:  SILC_STR_FUNC(function, void **value, void *context)

    This type can be used to call the `function' of the type
    SilcBufferFormatFunc or SilcBufferUnformatFunc to encode or decode
    the `value'.  In encoding the `value' will be passed to the `function'
    and can be encoded into the buffer.  The buffer will be passed as
    well to the `function' at the location where SILC_STR_FUNC is placed
    in formatting.  The `context' delivers caller specific context to
    the `function'

    In unformatting the `function' will decode the encoded type and
    return it to `value' pointer.  The decoding function should decide
    itself whether to allocate or not the decoded value.

    The `function' does not have to encode anything and passing `value'
    as NULL is allowed.  The `function' could for example modify the
    existing buffer.

EXAMPLE

    // Encode payload, encrypt and compute MAC.
    silc_buffer_format(buf,
                       SILC_STR_FUNC(foo_encode_id, id, ctx),
                       SILC_STR_UI_SHORT(len),
                       SILC_STR_DATA(data, len),
                       SILC_STR_FUNC(foo_buf_encrypt, NULL, key),
                       SILC_STR_FUNC(foo_buf_hmac, NULL, hmac),
                       SILC_STR_DATA(iv, iv_len);
                       SILC_STR_END);

    // Check MAC, decrypt and decode payload
    silc_buffer_unformat(buf,
                         SILC_STR_FUNC(foo_buf_hmac, NULL, hmac),
                         SILC_STR_FUNC(foo_buf_decrypt, NULL, key),
                         SILC_STR_FUNC(foo_decode_id, &id, ctx),
                         SILC_STR_UI_SHORT(&len),
                         SILC_STR_END);






SILC Buffer Format Interface
SilcBufferFormatFunc
SilcBufferSFormatFunc
SilcBufferUnformatFunc
SilcBufferSUnformatFunc
silc_buffer_format
silc_buffer_sformat
silc_buffer_format_vp
silc_buffer_sformat_vp
silc_buffer_unformat
silc_buffer_sunformat
silc_buffer_unformat_vp
silc_buffer_sunformat_vp
silc_buffer_strformat
silc_buffer_sstrformat
SilcBufferParamType
SILC_STR_*_CHAR
SILC_STR_*_SHORT
SILC_STR_*_INT
SILC_STR_*_INT64
SILC_STR_*_STRING
SILC_STR_*_NSTRING
SILC_STR_DATA
SILC_STR_BUFFER
SILC_STR_FUNC
SILC_STR_OFFSET
SILC_STR_ADVANCE
SILC_STR_END
SILC_STRFMT_END




Copyright © 2001 - 2007 SILC Project
SILC Project Website
SILC Toolkit Reference Manual
Index