BarrOff/nim-olm
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
This repository has moved to: https://codeberg.org/BarrOff/nim-olm
This repository has been archived on 2021-12-07. You can view files and clone it, but cannot push or open issues or pull requests.
2 Commits 1 Branch 1 Tag 26 KiB
Nim 100%
Go to file
BarrOff 1aa6170fe8 Move to Codeberg
2021-12-07 21:47:46 +01:00
src Initial commit 2021-01-13 17:50:56 +01:00
tests Initial commit 2021-01-13 17:50:56 +01:00
nimolm.nimble Initial commit 2021-01-13 17:50:56 +01:00
README.md Move to Codeberg 2021-12-07 21:47:46 +01:00

README.md

Notice

This repository has moved to Codeberg

Archive

Nim-olm is a Nim wrapper for the libolm library.

It is intentionally not published on Github, read here why.

Nim-olm is distributed as a Nimble package and depends on nimterop to generate the wrappers.

Installing

Nim-olm can be installed via Nimble:

nimble install https://gitea.com/BarrOff/nim-olm

This will download and install nim-olm in the standard Nimble package location, typically ~/.nimble. Once installed, it can be imported into any Nim program.

To use libolm installed in a standard system path like /usr/ or /usr/local the -d:olmStd flag has to be passed when compiling.

To download and build libolm from the official repo, the -d:olmDL flag has to be passed when compiling. The version of libolm to build can be set by -d:olmVersion=<version>, e.g. -d:olmVersion="3.2.1", the current default version to build is 3.1.2.

Usage

Nim-olm currently wraps libolm without any changes to it's C interface. For usage of the API, please refer to it's official documentation.

The maintainer is no expert in cryptography, and therefore won't write a higher-level wrapper. If you are familiar with cryptography, pull requests providing such an implementation are highly welcome.

import nimolm

var
  utilityBuffer: seq[char] = newSeq[char](olm_utility_size())
  utility: ptr OlmUtility = olm_utility(addr(utilityBuffer[0]))

More examples can be found in the tests-directory. These tests have been directly converted from the official testsuite.

Status

Nimterop currently only supports C, even though C++ support is in the works. Using libolm statically is therefore currently not possible, because the static library contains C and C++ code. The compiled binary has to be dynamically linked.

When nimterop stabilizes C++ support, building statically will be added.

Credits

Nim-olm wraps the libolm source code and all licensing terms of libolm apply to the usage of this package.

Without the following people nim-olm wouldn't be possible:

Feedback

Nim-olm is a work in progress and any feedback or suggestions are welcome. It is hosted on Gitea with an MIT license so issues, forks and PRs are most appreciated.