python-olm

Python的Olm绑定。

该库使用的Olm加密旋转规范可以在这里找到：这里。

该库使用的Megolm加密旋转规范可以在这里找到：这里。

Olm和Megolm加密协议的实现示例可以在Matrix协议中找到，该协议的实现指南可以在这里找到：这里。

完整的API参考可以在这里找到：这里。

安装说明

要从源包安装，您需要

• cmake（推荐）或GNU make
• C/C++编译器

然后您可以运行pip install python-olm。

这应该在UNIX-like环境中工作，包括macOS，也可能在其他环境中工作，但在Windows中尚未知。

账户

账户创建了Olm协议的中心身份，它们由指纹和身份密钥对组成。它们还生成一次性密钥，用于启动端到端加密通信通道。

账户创建

使用Account类创建新的账户，它创建一个新的Olm密钥对。密钥对的公钥部分可以通过类的identity_keys属性访问。

>>> alice = Account()
>>> alice.identity_keys
{'curve25519': '2PytGagXercwHjzQETLcMa3JOsaU2qkPIESaqoi59zE',
 'ed25519': 'HHpOuFYdHwoa54GxSttz9YmaTmbuVU3js92UTUjYJgM'}

一次性密钥

在人们可以开始与账户建立加密端到端通道之前，需要生成一次性密钥。

>>> alice.generate_one_time_keys(1)
>>> alice.one_time_keys
{'curve25519': {'AAAAAQ': 'KiHoW6CIy905UC4V1Frmwr3VW8bTWkBL4uWtWFFllxM'}}

一次性密钥发布后，应将其标记为已使用，以免重复使用。

>>> alice.mark_keys_as_published()
>>> alice.one_time_keys
{'curve25519': {}}

序列化

账户应存储以供以后重用，存储账户使用pickle方法，而恢复步骤使用from_pickle类方法完成。

>>> pickle = alice.pickle()
>>> restored = Account.from_pickle(pickle)

会话

会话用于在两个账户之间创建加密的端到端通信通道。

会话创建

>>> alice = Account()
>>> bob = Account()
>>> bob.generate_one_time_keys(1)
>>> id_key = bob.identity_keys["curve25519"]
>>> one_time = list(bob.one_time_keys["curve25519"].values())[0]
>>> alice_session = OutboundSession(alice, id_key, one_time)

加密

创建出站会话后，可以交换加密消息。

>>> message = alice_session.encrypt("It's a secret to everybody")
>>> message.ciphertext
'AwogkL7RoakT9gnjcZMra+y39WXKRmnxBPEaEp6OSueIA0cSIJxGpBoP8YZ+CGweXQ10LujbXMgK88
xG/JZMQJ5ulK9ZGiC8TYrezNYr3qyIBLlecXr/9wnegvJaSFDmWDVOcf4XfyI/AwogqIZfAklRXGC5b
ZJcZxVxQGgJ8Dz4OQII8k0Dp8msUXwQACIQvagY1dO55Qvnk5PZ2GF+wdKnvj6Zxl2g'
>>> message.message_type
0

消息传输后，Bob可以创建一个InboundSession来解密消息。

>>> bob_session = InboundSession(bob, message)
>>> bob_session.decrypt(message)
"It's a secret to everybody"

序列化

会话，像账户一样，可以存储以供以后使用，API与账户相同。

>>> pickle = session.pickle()
>>> restored = Session.from_pickle(pickle)

群组会话

群组会话用于创建一对一的多对一加密通信通道。群组会话密钥需要与所有应能解密群发消息的参与者共享。另一件事要注意的是，由于每次加密消息时群组会话密钥都会更新，因此在加密任何消息之前应共享会话密钥。

群组会话创建

群组会话不像端到端会话那样绑定到账户，因此其创建过程很简单。

>>> alice_group = OutboundGroupSession()
>>> bob_inbound_group = InboundGroupSession(alice_group.session_key)

群组加密

群组加密相当简单。重要的是要在安全通道（例如，端到端Olm会话）上与所有参与者共享会话密钥。

>>> message = alice_group.encrypt("It's a secret to everybody")
>>> bob_inbound_group.decrypt(message)
("It's a secret to everybody", 0)

序列化

序列化与端到端Olm会话相同。

>>> pickle = session.pickle()
>>> restored = InboundGroupSession.from_pickle(pickle)