Copyright © 2001 - 2005 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index

SILC Toolkit Reference Manual
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 ID Cache Interface
SILC Argument Interface
SILC Attributes Interface
Packet Protocol Interface
SILC Utility Library
Basic SILC Types
SILC Buffer Interface
SILC Buffer Format Interface
SILC Hash Table Interface
SILC Logging Interface
SILC Memory Interface
SILC Mutex Interface
SILC Thread Interface
SILC Network Interface
SILC Schedule Interface
SILC Socket Interface
SILC Protocol Interface
SILC Config Interface
SILC File Util Interface
SILC String Util Interface
SILC UTF-8 Interface
SILC Stringprep Interface
SILC Util Interface
SILC List Interface
SILC Dynamic List Interface
SILC VCard Interface
SILC Application Utilities
SILC MIME Interface
SILC Crypto Library
Introduction to SILC RNG
SILC RNG Interface
SILC Cipher API
SILC PKCS API
SILC PKCS#1 API
SILC Hash Interface
SILC HMAC Interface
SILC SFTP Library
SILC SFTP Interface
SFTP Filesystems 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
SILC Key Exchange Library
SILC SKE Interface
SKE Status Types
SKE Diffie Hellman Groups
SKE Payloads
SILC Math Library
SILC MP Interface
SILC Math Interface
Resource Links
SILC Project Website
SILC Protocol Documentation
SILC White Paper
SILC FAQs

Function silc_stringprep
SYNOPSIS

        SilcStringprepStatus
        silc_stringprep(const unsigned char *bin, SilcUInt32 bin_len,
                        SilcStringEncoding bin_encoding,
                        const char *profile_name,
                        SilcStringprepFlags flags,
                        unsigned char **out, SilcUInt32 *out_len,
                        SilcStringEncoding out_encoding);

DESCRIPTION

        Prepares the input string 'bin' of length 'bin_len' of encoding
        'bin_encoding' according to the stringrep profile 'profile_name'.
        Returns the prepared and allocated string into 'out'.  The 'out_len'
        indicates the length of the prepared string.  This returns the
        SilcStringprepStatus which indicates the status of the preparation.
        For example, if the input string contains prohibited characters
        (according to the used profile) this function will return error.
        The 'flags' however can be used to modify the behavior of this
        function.  Caller must free the returned 'out' string.

        The output string will be encoded into the character encoding
        defined by the 'out_encoding'.  This allows caller to have for
        example the input string as locale specific string and output string
        as UTF-8 encoded string.

        If the 'out' is NULL this function merely performs the preparation
        process, but does not return anything.  In this case this function
        could be used to for example verify that an input string that ought
        to have been prepared correctly was done so.

        Available profile names:

          SILC_IDENTIFIER_PREP            Prepares SILC identifier strings
          SILC_IDENTIFIER_CH_PREP         Prepares SILC channel name strings
          SILC_IDENTIFIERC_PREP           Casefolds identifier strings
          SILC_CASEFOLD_PREP              Casefolding and normalizing

SILC Stringprep SilcStringprepStatus SilcStringprepFlags silc_stringprep

Copyright © 2001 - 2005 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index