libressl/readme.md
torque fbd8c18115
Some checks are pending
CI / build (macos-latest, 0.13.0) (push) Waiting to run
CI / build (true, ubuntu-latest, master) (push) Waiting to run
CI / build (ubuntu-latest, 0.12.1) (push) Waiting to run
CI / build (ubuntu-latest, 0.13.0) (push) Waiting to run
CI / build (windows-latest, 0.13.0) (push) Waiting to run
readme: add additional information
2024-09-15 12:43:52 -07:00

1.5 KiB

LibreSSL

This is LibreSSL Portable, packaged for Zig.

Status

This project currently builds the three main LibreSSL libraries as static libraries:

  • libcrypto: core cryptographic routines
  • libssl: OpenSSL 1.1 compatibility layer
  • libtls: LibreSSL's new cryptography API

Operating systems and hardware architectures are supported on a best-effort basis. Building for Linux, macOS, and Windows (mingw64) is directly tested by CI.

The command line programs nc, ocspcheck, and openssl are not currently built by this build system.

Usage

First, update your build.zig.zon:

# Initialize a `zig build` project if you haven't already
zig init
# replace <refname> with the version you want to use, e.g. 3.9.2
zig fetch --save git+https://github.com/allyourcodebase/libressl#<refname>

You can then use libressl in your build.zig as follows:

const libressl_dependency = b.dependency("libressl", .{
    .target = target,
    .optimize = optimize,
    .@"enable-asm" = true, // enable assembly routines on supported platforms
});
your_exe.linkLibrary(libressl_dependency.artifact("tls")); // or "ssl", or "crypto"

Version Support Matrix

Refname LibreSSL Version Zig 0.12.x Zig 0.13.x Zig 0.14.0-dev
3.9.2 3.9.2