cipher.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef PURPLE_CIPHER_H
#define PURPLE_CIPHER_H
 
#include <glib.h>
#include <string.h>
 
#define PURPLE_CIPHER(obj)          ((PurpleCipher *)(obj))         
#define PURPLE_CIPHER_OPS(obj)      ((PurpleCipherOps *)(obj))      
#define PURPLE_CIPHER_CONTEXT(obj)  ((PurpleCipherContext *)(obj))  
typedef struct _PurpleCipher            PurpleCipher;           
typedef struct _PurpleCipherOps     PurpleCipherOps;        
typedef struct _PurpleCipherContext PurpleCipherContext;    
typedef enum _PurpleCipherBatchMode {
    PURPLE_CIPHER_BATCH_MODE_ECB,
    PURPLE_CIPHER_BATCH_MODE_CBC
} PurpleCipherBatchMode;
 
typedef enum _PurpleCipherCaps {
    PURPLE_CIPHER_CAPS_SET_OPT          = 1 << 1,   
    PURPLE_CIPHER_CAPS_GET_OPT          = 1 << 2,   
    PURPLE_CIPHER_CAPS_INIT             = 1 << 3,   
    PURPLE_CIPHER_CAPS_RESET            = 1 << 4,   
    PURPLE_CIPHER_CAPS_UNINIT           = 1 << 5,   
    PURPLE_CIPHER_CAPS_SET_IV           = 1 << 6,   
    PURPLE_CIPHER_CAPS_APPEND           = 1 << 7,   
    PURPLE_CIPHER_CAPS_DIGEST           = 1 << 8,   
    PURPLE_CIPHER_CAPS_ENCRYPT          = 1 << 9,   
    PURPLE_CIPHER_CAPS_DECRYPT          = 1 << 10,  
    PURPLE_CIPHER_CAPS_SET_SALT         = 1 << 11,  
    PURPLE_CIPHER_CAPS_GET_SALT_SIZE    = 1 << 12,  
    PURPLE_CIPHER_CAPS_SET_KEY          = 1 << 13,  
    PURPLE_CIPHER_CAPS_GET_KEY_SIZE     = 1 << 14,  
    PURPLE_CIPHER_CAPS_SET_BATCH_MODE   = 1 << 15,  
    PURPLE_CIPHER_CAPS_GET_BATCH_MODE   = 1 << 16,  
    PURPLE_CIPHER_CAPS_GET_BLOCK_SIZE   = 1 << 17,  
    PURPLE_CIPHER_CAPS_SET_KEY_WITH_LEN = 1 << 18,  
    PURPLE_CIPHER_CAPS_UNKNOWN          = 1 << 19   
} PurpleCipherCaps;
 
struct _PurpleCipherOps {
    void (*set_option)(PurpleCipherContext *context, const gchar *name, void *value);
 
    void *(*get_option)(PurpleCipherContext *context, const gchar *name);
 
    void (*init)(PurpleCipherContext *context, void *extra);
 
    void (*reset)(PurpleCipherContext *context, void *extra);
 
    void (*uninit)(PurpleCipherContext *context);
 
    void (*set_iv)(PurpleCipherContext *context, guchar *iv, size_t len);
 
    void (*append)(PurpleCipherContext *context, const guchar *data, size_t len);
 
    gboolean (*digest)(PurpleCipherContext *context, size_t in_len, guchar digest[], size_t *out_len);
 
    int (*encrypt)(PurpleCipherContext *context, const guchar data[], size_t len, guchar output[], size_t *outlen);
 
    int (*decrypt)(PurpleCipherContext *context, const guchar data[], size_t len, guchar output[], size_t *outlen);
 
    void (*set_salt)(PurpleCipherContext *context, guchar *salt);
 
    size_t (*get_salt_size)(PurpleCipherContext *context);
 
    void (*set_key)(PurpleCipherContext *context, const guchar *key);
 
    size_t (*get_key_size)(PurpleCipherContext *context);
 
    void (*set_batch_mode)(PurpleCipherContext *context, PurpleCipherBatchMode mode);
 
    PurpleCipherBatchMode (*get_batch_mode)(PurpleCipherContext *context);
 
    size_t (*get_block_size)(PurpleCipherContext *context);
 
    void (*set_key_with_len)(PurpleCipherContext *context, const guchar *key, size_t len);
};
 
G_BEGIN_DECLS
 
/*****************************************************************************/
/*****************************************************************************/
const gchar *purple_cipher_get_name(PurpleCipher *cipher);
 
guint purple_cipher_get_capabilities(PurpleCipher *cipher);
 
gboolean purple_cipher_digest_region(const gchar *name, const guchar *data, size_t data_len, size_t in_len, guchar digest[], size_t *out_len);
 
/******************************************************************************/
/******************************************************************************/
PurpleCipher *purple_ciphers_find_cipher(const gchar *name);
 
PurpleCipher *purple_ciphers_register_cipher(const gchar *name, PurpleCipherOps *ops);
 
gboolean purple_ciphers_unregister_cipher(PurpleCipher *cipher);
 
GList *purple_ciphers_get_ciphers(void);
 
/******************************************************************************/
/******************************************************************************/
gpointer purple_ciphers_get_handle(void);
 
void purple_ciphers_init(void);
 
void purple_ciphers_uninit(void);
 
/******************************************************************************/
/******************************************************************************/
void purple_cipher_context_set_option(PurpleCipherContext *context, const gchar *name, gpointer value);
 
gpointer purple_cipher_context_get_option(PurpleCipherContext *context, const gchar *name);
 
PurpleCipherContext *purple_cipher_context_new(PurpleCipher *cipher, void *extra);
 
PurpleCipherContext *purple_cipher_context_new_by_name(const gchar *name, void *extra);
 
void purple_cipher_context_reset(PurpleCipherContext *context, gpointer extra);
 
void purple_cipher_context_destroy(PurpleCipherContext *context);
 
void purple_cipher_context_set_iv(PurpleCipherContext *context, guchar *iv, size_t len);
 
void purple_cipher_context_append(PurpleCipherContext *context, const guchar *data, size_t len);
 
gboolean purple_cipher_context_digest(PurpleCipherContext *context, size_t in_len, guchar digest[], size_t *out_len);
 
gboolean purple_cipher_context_digest_to_str(PurpleCipherContext *context, size_t in_len, gchar digest_s[], size_t *out_len);
 
gint purple_cipher_context_encrypt(PurpleCipherContext *context, const guchar data[], size_t len, guchar output[], size_t *outlen);
 
gint purple_cipher_context_decrypt(PurpleCipherContext *context, const guchar data[], size_t len, guchar output[], size_t *outlen);
 
void purple_cipher_context_set_salt(PurpleCipherContext *context, guchar *salt);
 
size_t purple_cipher_context_get_salt_size(PurpleCipherContext *context);
 
void purple_cipher_context_set_key(PurpleCipherContext *context, const guchar *key);
 
size_t purple_cipher_context_get_key_size(PurpleCipherContext *context);
 
void purple_cipher_context_set_batch_mode(PurpleCipherContext *context, PurpleCipherBatchMode mode);
 
PurpleCipherBatchMode purple_cipher_context_get_batch_mode(PurpleCipherContext *context);
 
size_t purple_cipher_context_get_block_size(PurpleCipherContext *context);
 
void purple_cipher_context_set_key_with_len(PurpleCipherContext *context, const guchar *key, size_t len);
 
void purple_cipher_context_set_data(PurpleCipherContext *context, gpointer data);
 
gpointer purple_cipher_context_get_data(PurpleCipherContext *context);
 
/*****************************************************************************/
/*****************************************************************************/
gchar *purple_cipher_http_digest_calculate_session_key(
        const gchar *algorithm, const gchar *username,
        const gchar *realm, const gchar *password,
        const gchar *nonce, const gchar *client_nonce);
 
gchar *purple_cipher_http_digest_calculate_response(
        const gchar *algorithm, const gchar *method,
        const gchar *digest_uri, const gchar *qop,
        const gchar *entity, const gchar *nonce,
        const gchar *nonce_count, const gchar *client_nonce,
        const gchar *session_key);
 
G_END_DECLS
 
#endif /* PURPLE_CIPHER_H */