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

SILC Toolkit Reference Manual
SILC VCard Library
SILC VCard Interface
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 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 Math Library
SILC MP Interface
SILC Math Interface
SILC Application Utility Library
SILC Application Utilities
SILC ID Cache Interface
SILC Key Repository Library
SILC SKR Interface
SILC ASN.1 Library
SILC ASN.1 Interface
SILC BER interface
SILC Key Exchange Library
SILC SKE Interface
SILC Connection Authentication Interface
SILC SFTP Library
SILC SFTP Interface
SFTP Filesystems 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 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 HTTP Library
SILC HTTP Server Interface
SILC HTTP PHP Translator
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 - 2007 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index