https://github.com/zonyitoo/libsodium-ffi

libsodium native binding in Rust
https://github.com/zonyitoo/libsodium-ffi

Last synced: about 2 months ago
JSON representation

libsodium native binding in Rust

• Host: GitHub
• URL: https://github.com/zonyitoo/libsodium-ffi
• Owner: zonyitoo
• Created: 2015-01-27T04:55:25.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-12-07T21:20:28.000Z (about 5 years ago)
• Last Synced: 2024-10-03T12:44:33.929Z (3 months ago)
• Language: Rust
• Homepage:
• Size: 91.8 KB
• Stars: 31
• Watchers: 6
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## libsodium-ffi

[![Build Status](https://travis-ci.org/zonyitoo/libsodium-ffi.svg?branch=master)](https://travis-ci.org/zonyitoo/libsodium-ffi)

[![Build status](https://ci.appveyor.com/api/projects/status/em09bc2uktyvnf3h?svg=true)](https://ci.appveyor.com/project/zonyitoo/libsodium-ffi)

Rust native binding to [libsodium](https://github.com/jedisct1/libsodium)

```toml

# Cargo.toml

[dependencies]

libsodium-ffi = "0.2"

```

## Usage

Environement variables

- `SODIUM_LIB_DIR=/path/to/libsodium` for telling cargo where to find libsodium (Work with `SODIUM_INCLUDE_DIR`)

- `SODIUM_INCLUDE_DIR=/path/to/libsodium/include` for telling `bindgen` where to find libsodium's headers (Work with `SODIUM_LIB_DIR`)

- `SODIUM_STATIC=yes` for telling cargo to static-link libsodium

- `SODIUM_BUILD_STATIC=yes` force build from source instead of trying to find libsodium in system-wide

Examples

```bash

## Specify paths by hand

# This is the path to the directory of `/usr/local/lib/libsodium.a`

export SODIUM_LIB_DIR=/usr/local/lib

# This is the path to the directory of `/usr/local/include/sodium.h`

export SODIUM_INCLUDE_DIR=/usr/local/include

## Uses system-wide libsodium

# Statically link system-wide libsodium

export SODIUM_STATIC=yes

## Build libsodium from source

export SODIUM_BUILD_STATIC=yes

```

## Thanks

- `build.rs` is partially borrowed from [rust_sodium](https://github.com/maidsafe/rust_sodium/tree/master/rust_sodium-sys) project.