Skip to content

Latest commit

 

History

History
executable file
·
106 lines (67 loc) · 2.6 KB

README.md

File metadata and controls

executable file
·
106 lines (67 loc) · 2.6 KB
Raw

crypto

Library of common cryptographic algorithms and functions for Pony. Requires LibreSSL or OpenSSL. See installation for more details.

Status

Production ready.

Installation

  • Install corral
  • corral add github.com/ponylang/crypto.git --version 1.2.3
  • corral fetch to fetch your dependencies
  • use "crypto" to include this package
  • corral run -- ponyc to compile your application

Supported SSL versions

The 0.9.0, 1.1.x, and 3.0.x OpenSSL versions and corresponding compatible LibreSSL library versions are supported.

The default is to use the 0.9.x library APIs. You can change the selected supported library version at compile-time by using Pony's compile time definition functionality.

Using OpenSSL 0.9.0

corral run -- ponyc -Dopenssl_0.9.0

Using OpenSSL 1.1.x

corral run -- ponyc -Dopenssl_1.1.x

Using OpenSSL 3.0.x

corral run -- ponyc -Dopenssl_3.0.x

Dependencies

crypto requires either LibreSSL or OpenSSL in order to operate. You'll might need to install it within your environment of choice.

Installing on APT based Linux distributions

sudo apt-get install -y libssl-dev

Installing on Alpine Linux

apk add --update libressl-dev

Installing on Arch Linux

pacman -S openssl

Installing on macOS with Homebrew

brew update
brew install libressl

Installing on macOS with MacPorts

sudo port install libressl

Installing on RPM based Linux distributions with dnf

sudo dnf install openssl-devel

Installing on RPM based Linux distributions with yum

sudo yum install openssl-devel

Installing on RPM based Linux distributions with zypper

sudo zypper install libopenssl-devel

Installing on Windows

If you use Corral to include this package as dependency of a project, Corral will download and build LibreSSL for you the first time you run corral fetch. Otherwise, before using this package, you must run .\make.ps1 libs in its base directory to download and build LibreSSL for Windows. In both cases, you will need CMake (3.15 or higher) and 7Zip (7z.exe) in your PATH; and Visual Studio 2017 or later (or the Visual C++ Build Tools) installed in your system.

You should pass --define openssl_0.9.0 to Ponyc when using this package on Windows.

Examples

Examples can be found within the examples folder in this repository

API Documentation

https://ponylang.github.io/crypto/