//! This module provides a low level http interface for working with AWS //! It also provides an option to operate outside the AWS ecosystem through //! the makeRequest call with a null signingOptions. //! //! Typical usage: //! const client = awshttp.AwsHttp.init(allocator); //! defer client.deinit() //! const result = client.callApi (or client.makeRequest) //! defer result.deinit(); const std = @import("std"); const base = @import("aws_http_base.zig"); const signing = @import("aws_signing.zig"); const credentials = @import("aws_credentials.zig"); const zfetch = @import("zfetch"); const CN_NORTH_1_HASH = std.hash_map.hashString("cn-north-1"); const CN_NORTHWEST_1_HASH = std.hash_map.hashString("cn-northwest-1"); const US_ISO_EAST_1_HASH = std.hash_map.hashString("us-iso-east-1"); const US_ISOB_EAST_1_HASH = std.hash_map.hashString("us-isob-east-1"); const log = std.log.scoped(.awshttp); pub const AwsError = error{ AddHeaderError, AlpnError, CredentialsError, HttpClientConnectError, HttpRequestError, SignableError, SigningInitiationError, TlsError, RequestCreateError, SetupConnectionError, StatusCodeError, SetRequestMethodError, SetRequestPathError, }; pub const Options = struct { region: []const u8 = "aws-global", dualstack: bool = false, sigv4_service_name: ?[]const u8 = null, }; pub const Header = base.Header; pub const HttpRequest = base.Request; pub const HttpResult = base.Result; const EndPoint = struct { uri: []const u8, host: []const u8, scheme: []const u8, port: u16, allocator: std.mem.Allocator, fn deinit(self: EndPoint) void { self.allocator.free(self.uri); } }; pub const AwsHttp = struct { allocator: std.mem.Allocator, const Self = @This(); pub fn init(allocator: std.mem.Allocator) Self { return .{ .allocator = allocator, // .credentialsProvider = // creds provider could be useful }; } pub fn deinit(self: *AwsHttp) void { _ = self; log.debug("Deinit complete", .{}); } /// callApi allows the calling of AWS APIs through a higher-level interface. /// It will calculate the appropriate endpoint and action parameters for the /// service called, and will set up the signing options. The return /// value is simply a raw HttpResult pub fn callApi(self: Self, service: []const u8, request: HttpRequest, options: Options) !HttpResult { const endpoint = try regionSubDomain(self.allocator, service, options.region, options.dualstack); defer endpoint.deinit(); log.debug("Calling endpoint {s}", .{endpoint.uri}); const creds = try credentials.getCredentials(self.allocator); // defer allocator.free(), except sometimes we don't need freeing... const signing_config: signing.Config = .{ .region = options.region, .service = options.sigv4_service_name orelse service, .credentials = creds, }; return try self.makeRequest(endpoint, request, signing_config); } /// makeRequest is a low level http/https function that can be used inside /// or outside the context of AWS services. To use it outside AWS, simply /// pass a null value in for signing_options. /// /// Otherwise, it will simply take a URL endpoint (without path information), /// HTTP method (e.g. GET, POST, etc.), and request body. /// /// At the moment this does not allow the controlling of headers /// This is likely to change. Current headers are: /// /// Accept: application/json /// User-Agent: zig-aws 1.0, Powered by the AWS Common Runtime. /// Content-Type: application/x-www-form-urlencoded /// Content-Length: (length of body) /// /// Return value is an HttpResult, which will need the caller to deinit(). /// HttpResult currently contains the body only. The addition of Headers /// and return code would be a relatively minor change pub fn makeRequest(self: Self, endpoint: EndPoint, request: HttpRequest, signing_config: ?signing.Config) !HttpResult { log.debug("Path: {s}", .{request.path}); log.debug("Query: {s}", .{request.query}); log.debug("Method: {s}", .{request.method}); log.debug("body length: {d}", .{request.body.len}); log.debug("Body\n====\n{s}\n====", .{request.body}); // End CreateRequest. This should return a struct with a deinit function that can do // destroys, etc // TODO: Add headers _ = endpoint; //try self.addHeaders(endpoint.host, request.body, request.content_type, request.headers); if (signing_config) |opts| try signing.signRequest(self.allocator, request, opts); // TODO: make req try zfetch.init(); // This only does anything on Windows. Not sure how performant it is to do this on every request defer zfetch.deinit(); var headers = zfetch.Headers.init(self.allocator); defer headers.deinit(); for (request.headers) |header| try headers.appendValue(header.name, header.value); // TODO: Construct URL with endpoint and request info var req = try zfetch.Request.init(self.allocator, "https://www.lerch.org", null); // TODO: http method as requested // TODO: payload try req.do(.GET, headers, null); // TODO: Timeout - is this now above us? log.debug("request_complete. Response code {d}: {s}", .{ req.status.code, req.status.reason }); log.debug("headers:", .{}); var resp_headers = try std.ArrayList(Header).initCapacity(self.allocator, req.headers.list.items.len); for (req.headers.list.items) |h| { log.debug(" {s}: {s}", .{ h.name, h.value }); resp_headers.appendAssumeCapacity(.{ .name = h.name, .value = h.value }); } const reader = req.reader(); // TODO: Get content length and use that to allocate the buffer var buf: [65535]u8 = undefined; while (true) { const read = try reader.read(&buf); if (read == 0) break; } log.debug("raw response body:\n{s}", .{buf}); // Headers would need to be allocated/copied into HttpResult similar // to RequestContext, so we'll leave this as a later excercise // if it becomes necessary const rc = HttpResult{ .response_code = req.status.code, .body = "change me", // TODO: work this all out .headers = resp_headers.toOwnedSlice(), .allocator = self.allocator, }; return rc; } fn addHeaders(self: Self, host: []const u8, body: []const u8, content_type: []const u8, additional_headers: []Header) !void { _ = self; _ = host; _ = body; _ = content_type; _ = additional_headers; // const accept_header = c.aws_http_header{ // .name = c.aws_byte_cursor_from_c_str("Accept"), // .value = c.aws_byte_cursor_from_c_str("application/json"), // .compression = 0, // .AWS_HTTP_HEADER_COMPRESSION_USE_CACHE, // https://github.com/awslabs/aws-c-http/blob/ec42882310900f2b414b279fc24636ba4653f285/include/aws/http/request_response.h#L37 // }; // const host_header = c.aws_http_header{ // .name = c.aws_byte_cursor_from_c_str("Host"), // .value = c.aws_byte_cursor_from_c_str(@ptrCast([*c]const u8, host)), // .compression = 0, // .AWS_HTTP_HEADER_COMPRESSION_USE_CACHE, // }; // const user_agent_header = c.aws_http_header{ // .name = c.aws_byte_cursor_from_c_str("User-Agent"), // .value = c.aws_byte_cursor_from_c_str("zig-aws 1.0, Powered by the AWS Common Runtime."), // .compression = 0, // .AWS_HTTP_HEADER_COMPRESSION_USE_CACHE, // }; // AWS *does* seem to care about Content-Type. I don't think this header // will hold for all APIs // const c_type = try std.fmt.allocPrintZ(self.allocator, "{s}", .{content_type}); // defer self.allocator.free(c_type); // const content_type_header = c.aws_http_header{ // .name = c.aws_byte_cursor_from_c_str("Content-Type"), // .value = c.aws_byte_cursor_from_c_str(c_type), // .compression = 0, // .AWS_HTTP_HEADER_COMPRESSION_USE_CACHE, // }; // // for (additional_headers) |h| { // const name = try std.fmt.allocPrintZ(self.allocator, "{s}", .{h.name}); // defer self.allocator.free(name); // const value = try std.fmt.allocPrintZ(self.allocator, "{s}", .{h.value}); // defer self.allocator.free(value); // const c_header = c.aws_http_header{ // .name = c.aws_byte_cursor_from_c_str(name), // .value = c.aws_byte_cursor_from_c_str(value), // .compression = 0, // .AWS_HTTP_HEADER_COMPRESSION_USE_CACHE, // }; // if (c.aws_http_message_add_header(request, c_header) != c.AWS_OP_SUCCESS) // return AwsError.AddHeaderError; // } // // if (body.len > 0) { // const len = try std.fmt.allocPrintZ(self.allocator, "{d}", .{body.len}); // // This defer seems to work ok, but I'm a bit concerned about why // defer self.allocator.free(len); // const content_length_header = c.aws_http_header{ // .name = c.aws_byte_cursor_from_c_str("Content-Length"), // .value = c.aws_byte_cursor_from_c_str(@ptrCast([*c]const u8, len)), // .compression = 0, // .AWS_HTTP_HEADER_COMPRESSION_USE_CACHE, // }; // if (c.aws_http_message_add_header(request, content_length_header) != c.AWS_OP_SUCCESS) // return AwsError.AddHeaderError; // } } }; fn fullCast(comptime T: type, val: anytype) T { return @ptrCast(T, @alignCast(@alignOf(T), val)); } fn regionSubDomain(allocator: std.mem.Allocator, service: []const u8, region: []const u8, useDualStack: bool) !EndPoint { const environment_override = std.os.getenv("AWS_ENDPOINT_URL"); if (environment_override) |override| { const uri = try allocator.dupeZ(u8, override); return endPointFromUri(allocator, uri); } // Fallback to us-east-1 if global endpoint does not exist. const realregion = if (std.mem.eql(u8, region, "aws-global")) "us-east-1" else region; const dualstack = if (useDualStack) ".dualstack" else ""; const domain = switch (std.hash_map.hashString(region)) { US_ISO_EAST_1_HASH => "c2s.ic.gov", CN_NORTH_1_HASH, CN_NORTHWEST_1_HASH => "amazonaws.com.cn", US_ISOB_EAST_1_HASH => "sc2s.sgov.gov", else => "amazonaws.com", }; const uri = try std.fmt.allocPrintZ(allocator, "https://{s}{s}.{s}.{s}", .{ service, dualstack, realregion, domain }); const host = uri["https://".len..]; log.debug("host: {s}, scheme: {s}, port: {}", .{ host, "https", 443 }); return EndPoint{ .uri = uri, .host = host, .scheme = "https", .port = 443, .allocator = allocator, }; } /// creates an endpoint from a uri string. /// /// allocator: Will be used only to construct the EndPoint struct /// uri: string constructed in such a way that deallocation is needed fn endPointFromUri(allocator: std.mem.Allocator, uri: []const u8) !EndPoint { var scheme: []const u8 = ""; var host: []const u8 = ""; var port: u16 = 443; var host_start: usize = 0; var host_end: usize = 0; for (uri) |ch, i| { switch (ch) { ':' => { if (!std.mem.eql(u8, scheme, "")) { // here to end is port - this is likely a bug if ipv6 address used const rest_of_uri = uri[i + 1 ..]; port = try std.fmt.parseUnsigned(u16, rest_of_uri, 10); host_end = i; } }, '/' => { if (host_start == 0) { host_start = i + 2; scheme = uri[0 .. i - 1]; if (std.mem.eql(u8, scheme, "http")) { port = 80; } else { port = 443; } } }, else => continue, } } if (host_end == 0) { host_end = uri.len; } host = uri[host_start..host_end]; log.debug("host: {s}, scheme: {s}, port: {}", .{ host, scheme, port }); return EndPoint{ .uri = uri, .host = host, .scheme = scheme, .allocator = allocator, .port = port, }; }