python-otr Documentation
Next
python-otr Documentation
Table of Contents
Preamble
Disambiguation
1. News
Version 0.2 (libotr-3.2.0)
2. Using python-otr
Creating the UserState
Loading the private keys and the fingerprints
Connecting python-otr to your program (MessageAppOps)
Connecting your program to python-otr
Receiving messages
Sending messages
Verifying fingerprints' trusts
The manual way (libotr 3.0 compatible)
The modern way using a shared secret (libotr 3.1 and above)
I. Reference Manual
enum OtrlMessageState
— the possible encryption states of a
ConnContext
struct Fingerprint
— a structure describing a fingerprint
struct ConnContext
— a structure describing a connection
connection context
enum OtrlSessionIdHalf
— indicates which part of
ConnContext
's
sessionid
should be bold
otrl_context_find()
— Look up a connection
context
otrl_context_find_fingerprint()
— Look up a
fingerprint
otrl_context_set_trust()
— Set the trust level for a given
Fingerprint
otrl_context_force_finished()
— Force a
context
into the
OTRL_MSGSTATE_FINISHED
state
otrl_context_force_plaintext()
— Force a
context
into the
OTRL_MSGSTATE_PLAINTEXT
state
otrl_privkey_hash_to_human()
— Convert a 20-byte
“
raw
”
hash to a 45-byte human-readable value
otrl_privkey_fingerprint()
— returns the human-readable fingerprint of a given account
otrl_privkey_fingerprint_raw()
— returns the human-readable fingerprint of a given account
otrl_privkey_read()
— read private keys from a file
otrl_privkey_generate()
— generate a private key
otrl_privkey_read_fingerprints()
— read the fingerprint store from a file
otrl_privkey_write_fingerprints()
— write the fingerprint store to a file
struct OtrlUserState
— a structure describing a
“
User
”
otrl_userstate_create()
— Create a new OtrlUserState
TLV types
struct OtrlTLV
— a structure describing a TLV chain
otrl_tlv_find()
— find a TLV in a
OtrlTLV
chain
enum NextExpectedSMP
— reflects the type of the next expected SMP TLV
enum OtrlSMProgState
— the possible states of a SMP verification
struct OtrlSMState
— a structure describing the SMP status
Protocol constants
enum OtrlMessageType
— the possible types of internal messages transmitted
enum OtrlFragmentPolicy
— the possible ways how fragmented messages should be handled
otrl_proto_message_type()
— Return the Message type of the given message
enum OtrlNotifyLevel
— possible importancies for the
MessageAppOps
->notify() callback
otrl_message_sending()
— Handle a message about to be sent to the network
otrl_message_fragment_and_send()
— Send a message to the network, fragmenting it as necessary
otrl_message_receiving()
— Process a received message
otrl_message_disconnect()
— Gracefully disconnect an encrypted
ConnContext
otrl_message_initiate_smp()
— Initiate a SMP fingerprint verifying
otrl_message_initiate_smp_q()
— Initiate a SMP fingerprint verifying using a question hint
otrl_message_respond_smp()
— respond to a SMP fingerprint verifying
otrl_message_abort_smp()
— respond to a SMP fingerprint verifying