Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.63 KB

README.md

File metadata and controls

63 lines (37 loc) · 1.63 KB

docs

g3keymess

g3keymess is a server implementation of Cloudflare Keyless protocol.

How to build

You need to follow the dev-setup guide to set up your build environment first.

To build debug binaries:

cargo build -p g3keymess -p g3keymess-ctl

To build release binaries:

cargo build --profile release-lto -p g3keymess -p g3keymess-ctl

See Build and Package if you want to build binary packages or docker images.

Features

g3keymess uses the system OpenSSL by default.

You can specify the following feature flags to try others:

  • vendored-openssl

    Use the latest OpenSSL.

  • vendored-boringssl

    Use BoringSSL.

  • vendored-tongsuo

    Use Tongsuo.

Hardware Acceleration

It's possible to use hardware crypto engines by using OpenSSl ENGINES or OpenSSL PROVIDERS.

Use the following compilation feature flags to enable OpenSSL Async Job support:

cargo build --features openssl-async-job

You can build a hardware engine against the system OpenSSL, and enable it in openssl.cnf. If you don't want to change the default openssl.cnf, you can create a new one and export it as environment variable OPENSSL_CONF.

See Intel QAT Engine for more detailed installation steps.

Examples

See examples directory.