Skip to content

tardy-org/secsock

Repository files navigation

secsock

This is an implementation of SecureSocket, a wrapper for the Tardy Socket type that provides TLS functionality.

Discord

Supported TLS Backends

  • BearSSL: An implementation of the SSL/TLS protocol (RFC 5346) written in C.
  • s2n-tls: An implementation of SSL/TLS protocols by AWS. (Experimental)

Installing

For in development secsock which uses tardy/main and Zig 0.17.0-dev.956+2dca73595

zig fetch --save 'git+https://github.com/tardy-org/secsock?ref=main#commit_hash'

Else

Latest Release: 0.1.2 which uses tardy v0.3.2 and Zig 0.16.0

zig fetch --save 'git+https://github.com/tardy-org/secsock#v0.1.2'

You can then add the dependency in your build.zig file:

const secsock = b.dependency("secsock", .{
    .target = target,
    .optimize = optimize,
}).module("secsock");

exe.root_module.addImport(secsock);

Contribution

We use Nix Flakes for managing the development environment. Nix Flakes provide a reproducible, declarative approach to managing dependencies and development tools.

Prerequisites

sh <(curl -L https://nixos.org/nix/install) --daemon
  • Enable Flake support in your Nix config (~/.config/nix/nix.conf): experimental-features = nix-command flakes

Getting Started

  1. Clone this repository:
git clone https://github.com/tardy-org/secsock.git
cd secsock
  1. Enter the development environment:
nix develop

This will provide you with a shell that contains all of the necessary tools and dependencies for development.

Once you are inside of the development shell, you can update the development dependencies by:

  1. Modifying the flake.nix
  2. Running nix flake update
  3. Committing both the flake.nix and the flake.lock

License

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in secsock by you, shall be licensed as MPL2.0, without any additional terms or conditions.

About

Async TLS (Secure Socket) for the Tardy runtime

Topics

Resources

License

Stars

14 stars

Watchers

0 watching

Forks

Contributors

Languages