XML Security Library

LibXML2
LibXSLT
OpenSSL

xmlsec

Name

xmlsec -- Utility functions.

Types and Values

typedef xmlSecPtr
#define xmlSecSize
#define xmlSecByte
enum xmlSecCheckVersionMode
#define ATTRIBUTE_UNUSED

Description

Utility functions.

Functions

XMLSEC_SIZE_BAD_CAST()

#define XMLSEC_SIZE_BAD_CAST(val)               ((xmlSecSize)(val))

Bad cast to xmlSecSize

Parameters

val

the value to cast


xmlSecInit ()

int
xmlSecInit (void);

Initializes XML Security Library. The depended libraries (LibXML and LibXSLT) must be initialized before.

Returns

0 on success or a negative value otherwise.


xmlSecShutdown ()

int
xmlSecShutdown (void);

Gets the default crypto engine ("openssl", "nss", etc.) for the XML Security Library.

Returns

the default crypto engine ("openssl", "nss", etc.).


xmlSecGetDefaultCrypto ()

const xmlChar *
xmlSecGetDefaultCrypto (void);


XMLSEC_CRYPTO

#define XMLSEC_CRYPTO                          (xmlSecGetDefaultCrypto())

Macro. Deprecated. Defined for backward compatibility only. Do not use in your code and use xmlSecGetDefaultCrypto() function instead.

Returns the default crypto engine.


xmlSecCheckVersionExact

#define             xmlSecCheckVersionExact()

Macro. Returns 1 if the loaded xmlsec library version exactly matches the one used to compile the caller, 0 if it does not or a negative value if an error occurs.


xmlSecCheckVersion

#define             xmlSecCheckVersion()

Macro. Returns 1 if the loaded xmlsec library version ABI compatible with the one used to compile the caller, 0 if it does not or a negative value if an error occurs.


xmlSecCheckVersionExt ()

int
xmlSecCheckVersionExt (int major,
                       int minor,
                       int subminor,
                       xmlSecCheckVersionMode mode);

Checks if the loaded version of xmlsec library could be used.

Parameters

major

the major version number.

minor

the minor version number.

subminor

the subminor version number.

mode

the version check mode.

Returns

1 if the loaded xmlsec library version is OK to use 0 if it is not or a negative value if an error occurs.


XMLSEC_PTR_TO_FUNC_IMPL()

#define             XMLSEC_PTR_TO_FUNC_IMPL(func_type)

Macro declares helper functions to convert between "void *" pointer and function pointer.

Parameters

func_type

the function type.


XMLSEC_PTR_TO_FUNC()

#define             XMLSEC_PTR_TO_FUNC(func_type, ptr)

Macro converts from "void*" pointer to "func_type" function pointer.

Parameters

func_type

the function type.

ptr

the "void*" pointer to be converted.


XMLSEC_FUNC_TO_PTR()

#define             XMLSEC_FUNC_TO_PTR(func_type, func)

Macro converts from "func_type" function pointer to "void*" pointer.

Parameters

func_type

the function type.

func

the "func_type" function pointer to be converted.

Types and Values

xmlSecPtr

typedef void*                                   xmlSecPtr;

Void pointer.


xmlSecSize

#define xmlSecSize                              unsigned int

Size of something. Should be typedef instead of define but it will break ABI (todo).


xmlSecByte

#define xmlSecByte                              unsigned char

One byte. Should be typedef instead of define but it will break ABI (todo).


enum xmlSecCheckVersionMode

The xmlsec library version mode.

Members

xmlSecCheckVersionExactMatch

the version should match exactly.

xmlSecCheckVersionABICompatible

the version should be ABI compatible.


ATTRIBUTE_UNUSED

#define ATTRIBUTE_UNUSED

Macro used to signal to GCC unused function parameters