Top | ![]() |
![]() |
![]() |
![]() |
struct | CamelCipherContext |
struct | CamelCipherValidity |
struct | CamelCipherCertInfo |
enum | CamelCipherHash |
enum | camel_cipher_validity_sign_t |
enum | camel_cipher_validity_encrypt_t |
enum | camel_cipher_validity_mode_t |
CamelCipherContext *
camel_cipher_context_new (CamelSession *session
);
This creates a new CamelCipherContext object which is used to sign, verify, encrypt and decrypt streams.
CamelSession *
camel_cipher_context_get_session (CamelCipherContext *context
);
Since: 2.32
CamelCipherHash camel_cipher_context_id_to_hash (CamelCipherContext *context
,const gchar *id
);
const gchar * camel_cipher_context_hash_to_id (CamelCipherContext *context
,CamelCipherHash hash
);
gboolean camel_cipher_context_sign_sync (CamelCipherContext *context
,const gchar *userid
,CamelCipherHash hash
,CamelMimePart *ipart
,CamelMimePart *opart
,GCancellable *cancellable
,GError **error
);
Converts the (unsigned) part ipart
into a new self-contained MIME
part opart
. This may be a multipart/signed part, or a simple part
for enveloped types.
context |
||
userid |
a private key to use to sign the stream |
|
hash |
preferred Message-Integrity-Check hash algorithm |
|
ipart |
input CamelMimePart |
|
opart |
output CamelMimePart |
|
cancellable |
optional GCancellable object, or |
|
error |
return location for a GError, or |
Since: 3.0
void camel_cipher_context_sign (CamelCipherContext *context
,const gchar *userid
,CamelCipherHash hash
,CamelMimePart *ipart
,CamelMimePart *opart
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously converts the (unsigned) part ipart
into a new
self-contained MIME part opart
. This may be a multipart/signed part,
or a simple part for enveloped types.
When the operation is finished, callback
will be called. You can then
call camel_cipher_context_sign_finish()
to get the result of the operation.
context |
||
userid |
a private key to use to sign the stream |
|
hash |
preferred Message-Integrity-Check hash algorithm |
|
ipart |
input CamelMimePart |
|
opart |
output CamelMimePart |
|
io_priority |
the I/O priority of the request |
|
cancellable |
optional GCancellable object, or |
|
callback |
a GAsyncReadyCallback to call when the request is satisfied |
|
user_data |
data to pass to the callback function |
Since: 3.0
gboolean camel_cipher_context_sign_finish (CamelCipherContext *context
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_cipher_context_sign()
.
Since: 3.0
CamelCipherValidity * camel_cipher_context_verify_sync (CamelCipherContext *context
,CamelMimePart *ipart
,GCancellable *cancellable
,GError **error
);
Verifies the signature.
context |
||
ipart |
the CamelMimePart to verify |
|
cancellable |
optional GCancellable object, or |
|
error |
return location for a GError, or |
a CamelCipherValidity structure containing information
about the integrity of the input stream, or NULL
on failure to
execute at all
void camel_cipher_context_verify (CamelCipherContext *context
,CamelMimePart *ipart
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously verifies the signature.
When the operation is finished, callback
will be called. You can
then call camel_cipher_context_verify_finish()
to get the result of
the operation.
context |
||
ipart |
the CamelMimePart to verify |
|
io_priority |
the I/O priority of the request |
|
cancellable |
optional GCancellable object, or |
|
callback |
a GAsyncReadyCallback to call when the request is satisfied |
|
user_data |
data to pass to the callback function |
Since: 3.0
CamelCipherValidity * camel_cipher_context_verify_finish (CamelCipherContext *context
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_cipher_context_verify()
.
a CamelCipherValidity structure containing information
about the integrity of the input stream, or NULL
on failure to
execute at all
Since: 3.0
gboolean camel_cipher_context_encrypt_sync (CamelCipherContext *context
,const gchar *userid
,GPtrArray *recipients
,CamelMimePart *ipart
,CamelMimePart *opart
,GCancellable *cancellable
,GError **error
);
Encrypts (and optionally signs) the clear-text ipart
and writes the
resulting cipher-text to opart
.
context |
||
userid |
key ID (or email address) to use when signing, or |
|
recipients |
an array of recipient key IDs and/or email addresses |
|
ipart |
clear-text CamelMimePart |
|
opart |
cipher-text CamelMimePart |
|
cancellable |
optional GCancellable object, or |
|
error |
return location for a GError, or |
Since: 3.0
void camel_cipher_context_encrypt (CamelCipherContext *context
,const gchar *userid
,GPtrArray *recipients
,CamelMimePart *ipart
,CamelMimePart *opart
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously encrypts (and optionally signs) the clear-text ipart
and
writes the resulting cipher-text to opart
.
When the operation is finished, callback
will be called. You can
then call camel_cipher_context_encrypt_finish()
to get the result of
the operation.
context |
||
userid |
key id (or email address) to use when signing, or |
|
recipients |
an array of recipient key IDs and/or email addresses |
|
ipart |
clear-text CamelMimePart |
|
opart |
cipher-text CamelMimePart |
|
io_priority |
the I/O priority of the request |
|
cancellable |
optional GCancellable object, or |
|
callback |
a GAsyncReadyCallback to call when the request is satisfied |
|
user_data |
data to pass to the callback function |
Since: 3.0
gboolean camel_cipher_context_encrypt_finish (CamelCipherContext *context
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_cipher_context_encrypt()
.
Since: 3.0
CamelCipherValidity * camel_cipher_context_decrypt_sync (CamelCipherContext *context
,CamelMimePart *ipart
,CamelMimePart *opart
,GCancellable *cancellable
,GError **error
);
Decrypts ipart
into opart
.
context |
||
ipart |
cipher-text CamelMimePart |
|
opart |
clear-text CamelMimePart |
|
cancellable |
optional GCancellable object, or |
|
error |
return location for a GError, or |
Since: 3.0
void camel_cipher_context_decrypt (CamelCipherContext *context
,CamelMimePart *ipart
,CamelMimePart *opart
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously decrypts ipart
into opart
.
When the operation is finished, callback
will be called. You can
then call camel_cipher_context_decrypt_finish()
to get the result of
the operation.
context |
||
ipart |
cipher-text CamelMimePart |
|
opart |
clear-text CamelMimePart |
|
io_priority |
the I/O priority of the request |
|
cancellable |
optional GCancellable object, or |
|
callback |
a GAsyncReadyCallback to call when the request is satisfied |
|
user_data |
data to pass to the callback function |
Since: 3.0
CamelCipherValidity * camel_cipher_context_decrypt_finish (CamelCipherContext *context
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_cipher_context_decrypt()
.
Since: 3.0
gboolean
camel_cipher_validity_get_valid (CamelCipherValidity *validity
);
void camel_cipher_validity_set_valid (CamelCipherValidity *validity
,gboolean valid
);
gchar *
camel_cipher_validity_get_description (CamelCipherValidity *validity
);
void camel_cipher_validity_set_description (CamelCipherValidity *validity
,const gchar *description
);
CamelCipherValidity *
camel_cipher_validity_clone (CamelCipherValidity *vin
);
void camel_cipher_validity_add_certinfo (CamelCipherValidity *vin
,camel_cipher_validity_mode_t mode
,const gchar *name
,const gchar *email
);
Add a cert info to the signer or encrypter info.
void camel_cipher_validity_add_certinfo_ex (CamelCipherValidity *vin
,camel_cipher_validity_mode_t mode
,const gchar *name
,const gchar *email
,gpointer cert_data
,void (*cert_data_free) (gpointer cert_data)
,gpointer (*cert_data_clone) (gpointer cert_data)
);
Add a cert info to the signer or encrypter info, with extended data set.
Since: 2.30
void camel_cipher_validity_envelope (CamelCipherValidity *parent
,CamelCipherValidity *valid
);
Calculate a conglomerate validity based on wrapping one secure part inside another one.
gint camel_cipher_canonical_to_stream (CamelMimePart *part
,guint32 flags
,CamelStream *ostream
,GCancellable *cancellable
,GError **error
);
Writes a part to a stream in a canonicalised format, suitable for signing/encrypting.
The transfer encoding paramaters for the part may be changed by this function.
struct CamelCipherValidity { GQueue children; struct { enum _camel_cipher_validity_sign_t status; gchar *description; GQueue signers; /* CamelCipherCertInfo's */ } sign; struct { enum _camel_cipher_validity_encrypt_t status; gchar *description; GQueue encrypters; /* CamelCipherCertInfo's */ } encrypt; };
struct CamelCipherCertInfo { gchar *name; /* common name */ gchar *email; gpointer cert_data; /* custom certificate data; can be NULL */ void (*cert_data_free) (gpointer cert_data); /* called to free cert_data; can be NULL only if cert_data is NULL */ gpointer (*cert_data_clone) (gpointer cert_data); /* called to clone cert_data; can be NULL only if cert_data is NULL */ };