readme.md

Zig-TLS12

HTTP client capable of TLS 1.2.

You may use HttpClient in the same way you use std.http.Client. The only difference of HttpClient from std.http.Client is that std.crypto.tls.Client which supports TLS 1.3 is replaced by a TLS 1.2 capable TlsClient.

Usage

Add to build.zig.zon:

.{
    .dependencies = .{
        // other dependencies...
        .tls12 = .{
            // Check releases for other versions
            .url = "https://github.com/melonedo/zig-tls12/archive/refs/heads/main.zip",
            // Let zon find out
            .hash = "12341234123412341234123412341234123412341234123412341234123412341234",
        },
    },
}

Add to build.zig:

// const exe = b.addExecutable(...);
const tls12 = b.dependency("tls12", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("tls12", tls12.module("zig-tls12"));

In zig program:

// Drop-in replacement of std.http.Client
const HttpClient = @import("tls12");

Example

This is tested againt zig version 0.12.0-dev.3674+a0de07760. Zig's HTTP interface has changed so it DOES NOT WORK on 0.11 and below.

const std = @import("std");
// With zon:    const HttpClient = @import("tls12");
// With stdlib: const HttpClient = std.http.Client;
const HttpClient = @import("HttpClient.zig");

pub fn main() !void {
    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
    defer arena.deinit();
    const allocator = arena.allocator();

    var client = HttpClient{ .allocator = allocator };
    defer client.deinit();
    try client.initDefaultProxies(allocator);

    const url = "https://httpbin.org";

    const uri = try std.Uri.parse(url);
    var server_header_buffer: [1024 * 1024]u8 = undefined;
    var req = try HttpClient.open(&client, .GET, uri, .{
        .server_header_buffer = &server_header_buffer,
        .redirect_behavior = @enumFromInt(10),
    });
    defer req.deinit();

    try req.send();
    try req.wait();
    const body = try req.reader().readAllAlloc(allocator, 16 * 1024 * 1024);
    defer allocator.free(body);

    std.debug.print("{s}: {s}\n", .{ url, body });
}