Overview | Namespace | Class | Index | Help

## Global Functions in Global Namespace C++
in Sourcefile digest.h

rtl_digest_HMAC_MD5
  extern "C"
  rtlDigestError rtl_digest_HMAC_MD5(

    const sal_uInt8 * | pKeyData,
    sal_uInt32 | nKeyLen,
    const void * | pData,
    sal_uInt32 | nDatLen,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Evaluate a HMAC_MD5 digest value from given data.
  Description
    This function performs an optimized call sequence on a single data buffer, avoiding digest creation and destruction.
  See Also
    rtl_digest_initHMAC_MD5()
    rtl_digest_updateHMAC_MD5()
    rtl_digest_getHMAC_MD5()
  Parameters

    pKeyData |
        key material buffer.
    nKeyLen |
        key material length.
    pData |
        data buffer.
    nDatLen |
        data length.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_HMAC_SHA1
  extern "C"
  rtlDigestError rtl_digest_HMAC_SHA1(

    const sal_uInt8 * | pKeyData,
    sal_uInt32 | nKeyLen,
    const void * | pData,
    sal_uInt32 | nDatLen,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Evaluate a HMAC_SHA1 digest value from given data.
  Description
    This function performs an optimized call sequence on a single data buffer, avoiding digest creation and destruction.
  See Also
    rtl_digest_initHMAC_SHA1()
    rtl_digest_updateHMAC_SHA1()
    rtl_digest_getHMAC_SHA1()
  Parameters

    pKeyData |
        key material buffer.
    nKeyLen |
        key material length.
    pData |
        data buffer.
    nDatLen |
        data length.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_MD2
  extern "C"
  rtlDigestError rtl_digest_MD2(

    const void * | pData,
    sal_uInt32 | nDatLen,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Evaluate a MD2 digest value from given data.
  Description
    This function performs an optimized call sequence on a single data buffer, avoiding digest creation and destruction.
  See Also
    rtl_digest_updateMD2()
    rtl_digest_getMD2()
  Parameters

    pData |
        data buffer.
    nDatLen |
        data length.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_MD5
  extern "C"
  rtlDigestError rtl_digest_MD5(

    const void * | pData,
    sal_uInt32 | nDatLen,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Evaluate a MD5 digest value from given data.
  Description
    This function performs an optimized call sequence on a single data buffer, avoiding digest creation and destruction.
  See Also
    rtl_digest_updateMD5()
    rtl_digest_getMD5()
  Parameters

    pData |
        data buffer.
    nDatLen |
        data length.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_PBKDF2
  extern "C"
  rtlDigestError rtl_digest_PBKDF2(

    sal_uInt8 * | pKeyData,
    sal_uInt32 | nKeyLen,
    const sal_uInt8 * | pPassData,
    sal_uInt32 | nPassLen,
    const sal_uInt8 * | pSaltData,
    sal_uInt32 | nSaltLen,
    sal_uInt32 | nCount );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Password-Based Key Derivation Function.
  Description
    The PBKDF2 key derivation function is specified in RFC 2898 (Informational) PKCS #5: Password-Based Cryptography Specification Version 2.0
  Parameters

    pKeyData |
        derived key
    nKeyLen |
        derived key length
    pPassData |
        password
    nPassLen |
        password length
    pSaltData |
        salt
    nSaltLen |
        salt length
    nCount |
        iteration count

  Return
    rtl_Digest_E_None upon success.

rtl_digest_SHA
  extern "C"
  rtlDigestError rtl_digest_SHA(

    const void * | pData,
    sal_uInt32 | nDatLen,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Evaluate a SHA digest value from given data.
  Description
    This function performs an optimized call sequence on a single data buffer, avoiding digest creation and destruction.
  See Also
    rtl_digest_updateSHA()
    rtl_digest_getSHA()
  Parameters

    pData |
        data buffer.
    nDatLen |
        data length.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_SHA1
  extern "C"
  rtlDigestError rtl_digest_SHA1(

    const void * | pData,
    sal_uInt32 | nDatLen,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Evaluate a SHA1 digest value from given data.
  Description
    This function performs an optimized call sequence on a single data buffer, avoiding digest creation and destruction.
  See Also
    rtl_digest_updateSHA1()
    rtl_digest_getSHA1()
  Parameters

    pData |
        data buffer.
    nDatLen |
        data length.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_create
  extern "C"
  rtlDigest rtl_digest_create(

    rtlDigestAlgorithm | Algorithm );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a digest handle for the given algorithm.
  See Also
    rtlDigestAlgorithm
  Parameters

    Algorithm |
        digest algorithm.

  Return
    Digest handle, or 0 upon failure.

rtl_digest_createHMAC_MD5
  extern "C"
  rtlDigest rtl_digest_createHMAC_MD5(

    void | );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a HMAC_MD5 digest handle.
  Description
    The HMAC_MD5 digest algorithm is specified in RFC 2104 (Informational) HMAC: Keyed-Hashing for Message Authentication
  See Also
    rtl_digest_create()

rtl_digest_createHMAC_SHA1
  extern "C"
  rtlDigest rtl_digest_createHMAC_SHA1(

    void | );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a HMAC_SHA1 digest handle.
  Description
    The HMAC_SHA1 digest algorithm is specified in RFC 2104 (Informational) HMAC: Keyed-Hashing for Message Authentication RFC 2898 (Informational) PKCS #5: Password-Based Cryptography Specification Version 2.0
  See Also
    rtl_digest_create()

rtl_digest_createMD2
  extern "C"
  rtlDigest rtl_digest_createMD2(

    void | );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a MD2 digest handle.
  Description
    The MD2 digest algorithm is specified in RFC 1319 (Informational) The MD2 Message-Digest Algorithm
  See Also
    rtl_digest_create()

rtl_digest_createMD5
  extern "C"
  rtlDigest rtl_digest_createMD5(

    void | );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a MD5 digest handle.
  Description
    The MD5 digest algorithm is specified in RFC 1321 (Informational) The MD5 Message-Digest Algorithm
  See Also
    rtl_digest_create()

rtl_digest_createSHA
  extern "C"
  rtlDigest rtl_digest_createSHA(

    void | );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a SHA digest handle.
  Description
    The SHA digest algorithm is specified in FIPS PUB 180 (Superseded by FIPS PUB 180-1) Secure Hash Standard
  See Also
    rtl_digest_create()

rtl_digest_createSHA1
  extern "C"
  rtlDigest rtl_digest_createSHA1(

    void | );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Create a SHA1 digest handle.
  Description
    The SHA1 digest algorithm is specified in FIPS PUB 180-1 (Supersedes FIPS PUB 180) Secure Hash Standard
  See Also
    rtl_digest_create()

rtl_digest_destroy
  extern "C"
  void rtl_digest_destroy(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a digest handle.
  Postcondition
    Digest handle destroyed and invalid.
  Parameters

    Digest |
        digest handle to be destroyed.

  Return
    None.

rtl_digest_destroyHMAC_MD5
  extern "C"
  void rtl_digest_destroyHMAC_MD5(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a HMAC_MD5 digest handle.
  See Also
    rtl_digest_destroy()

rtl_digest_destroyHMAC_SHA1
  extern "C"
  void rtl_digest_destroyHMAC_SHA1(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a HMAC_SHA1 digest handle.
  See Also
    rtl_digest_destroy()

rtl_digest_destroyMD2
  extern "C"
  void rtl_digest_destroyMD2(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a MD2 digest handle.
  See Also
    rtl_digest_destroy()

rtl_digest_destroyMD5
  extern "C"
  void rtl_digest_destroyMD5(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a MD5 digest handle.
  See Also
    rtl_digest_destroy()

rtl_digest_destroySHA
  extern "C"
  void rtl_digest_destroySHA(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a SHA digest handle.
  See Also
    rtl_digest_destroy()

rtl_digest_destroySHA1
  extern "C"
  void rtl_digest_destroySHA1(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Destroy a SHA1 digest handle.
  See Also
    rtl_digest_destroy()

rtl_digest_get
  extern "C"
  rtlDigestError rtl_digest_get(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a digest and retrieve the digest value.
  Precondition
    Digest value length must not be less than digest length.
  Postcondition
    Digest initialized to accept another update sequence.
  See Also
    rtl_digest_queryLength()
    rtl_digest_update()
  Parameters

    Digest |
        digest handle.
    pBuffer |
        digest value buffer.
    nBufLen |
        digest value length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_getHMAC_MD5
  extern "C"
  rtlDigestError rtl_digest_getHMAC_MD5(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a HMAC_MD5 digest and retrieve the digest value.
  See Also
    rtl_digest_get()

rtl_digest_getHMAC_SHA1
  extern "C"
  rtlDigestError rtl_digest_getHMAC_SHA1(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a HMAC_SHA1 digest and retrieve the digest value.
  See Also
    rtl_digest_get()

rtl_digest_getMD2
  extern "C"
  rtlDigestError rtl_digest_getMD2(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a MD2 digest and retrieve the digest value.
  See Also
    rtl_digest_get()

rtl_digest_getMD5
  extern "C"
  rtlDigestError rtl_digest_getMD5(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a MD5 digest and retrieve the digest value.
  See Also
    rtl_digest_get()

rtl_digest_getSHA
  extern "C"
  rtlDigestError rtl_digest_getSHA(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a SHA digest and retrieve the digest value.
  See Also
    rtl_digest_get()

rtl_digest_getSHA1
  extern "C"
  rtlDigestError rtl_digest_getSHA1(

    rtlDigest | Digest,
    sal_uInt8 * | pBuffer,
    sal_uInt32 | nBufLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Finalize a SHA1 digest and retrieve the digest value.
  See Also
    rtl_digest_get()

rtl_digest_init
  extern "C"
  rtlDigestError rtl_digest_init(

    rtlDigest | Digest,
    const sal_uInt8 * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Initialize a digest with given data.
  Parameters

    Digest |
        digest handle.
    pData |
        data buffer.
    nDatLen |
        data length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_initHMAC_MD5
  extern "C"
  rtlDigestError rtl_digest_initHMAC_MD5(

    rtlDigest | Digest,
    const sal_uInt8 * | pKeyData,
    sal_uInt32 | nKeyLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Initialize a HMAC_MD5 digest.
  See Also
    rtl_digest_init()
  Parameters

    Digest |
        digest handle.
    pKeyData |
        key material buffer.
    nKeyLen |
        key material length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_initHMAC_SHA1
  extern "C"
  rtlDigestError rtl_digest_initHMAC_SHA1(

    rtlDigest | Digest,
    const sal_uInt8 * | pKeyData,
    sal_uInt32 | nKeyLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Initialize a HMAC_SHA1 digest.
  See Also
    rtl_digest_init()
  Parameters

    Digest |
        digest handle.
    pKeyData |
        key material buffer.
    nKeyLen |
        key material length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_queryAlgorithm
  extern "C"
  rtlDigestAlgorithm rtl_digest_queryAlgorithm(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Query the algorithm of a given digest.
  Parameters

    Digest |
        digest handle.

  Return
    digest algorithm, or rtl_Digest_AlgorithmInvalid upon failure.

rtl_digest_queryLength
  extern "C"
  sal_uInt32 rtl_digest_queryLength(

    rtlDigest | Digest );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Query the length of a given digest.
  Parameters

    Digest |
        digest handle.

  Return
    digest length, or 0 upon failure.

rtl_digest_update
  extern "C"
  rtlDigestError rtl_digest_update(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a digest with given data.
  Parameters

    Digest |
        digest handle.
    pData |
        data buffer.
    nDatLen |
        data length.

  Return
    rtl_Digest_E_None upon success.

rtl_digest_updateHMAC_MD5
  extern "C"
  rtlDigestError rtl_digest_updateHMAC_MD5(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a HMAC_MD5 digest with given data.
  See Also
    rtl_digest_update()

rtl_digest_updateHMAC_SHA1
  extern "C"
  rtlDigestError rtl_digest_updateHMAC_SHA1(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a HMAC_SHA1 digest with given data.
  See Also
    rtl_digest_update()

rtl_digest_updateMD2
  extern "C"
  rtlDigestError rtl_digest_updateMD2(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a MD2 digest with given data.
  See Also
    rtl_digest_update()

rtl_digest_updateMD5
  extern "C"
  rtlDigestError rtl_digest_updateMD5(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a MD5 digest with given data.
  See Also
    rtl_digest_update()

rtl_digest_updateSHA
  extern "C"
  rtlDigestError rtl_digest_updateSHA(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a SHA digest with given data.
  See Also
    rtl_digest_update()

rtl_digest_updateSHA1
  extern "C"
  rtlDigestError rtl_digest_updateSHA1(

    rtlDigest | Digest,
    const void * | pData,
    sal_uInt32 | nDatLen );

  virtual | abstract | const | volatile | template | static | inline | C-linkage
  NO | NO | NO | NO | NO | NO | NO | YES

  Summary
    Update a SHA1 digest with given data.
  See Also
    rtl_digest_update()

Top of Page

Copyright © 2003 Sun Microsystems, Inc.