lobo/aws-sdk-for-zig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
AWS SDK for Zig
207 Commits 7 Branches 2 Tags 20 MiB
Zig 99.9%
Makefile 0.1%
ab1060b145
Go to file
Emil Lerch ab1060b145
Some checks failed
continuous-integration/drone/push Build is failing
Details
s3 listallbuckets/putobject working
2022-05-31 18:47:59 -07:00
codegen add http_payload type declaration based on smithy model 2022-05-28 18:00:38 -07:00
smithy add http_payload type declaration based on smithy model 2022-05-28 18:00:38 -07:00
src s3 listallbuckets/putobject working 2022-05-31 18:47:59 -07:00
.drone.yml revert to zig 0.9.0. iguanaTLS broken on 0.9.1 2022-03-10 09:13:42 -08:00
.gitignore add macos to CI 2022-02-08 22:36:36 -08:00
Amazon_Root_CA_1.pem add tls trust chain for AWS 2022-01-19 21:17:44 -08:00
build_test.zig add build_test/VersionStep 2022-01-12 16:52:45 -08:00
build.zig make codegen dependent on any source update in codegen directory 2022-05-28 15:29:17 -07:00
CopyStep.zig dig out aws crt. project no longer builds 2022-01-10 21:49:59 -08:00
GitRepoStep.zig update GitRepoStep to change to correct revision prior to updating submodules 2022-03-09 17:30:48 -08:00
LICENSE first thing that actually works 2021-04-27 11:24:01 -07:00
Makefile first thing that actually works 2021-04-27 11:24:01 -07:00
README.md rest_xml support, minus s3 2022-05-28 20:18:16 -07:00
VersionStep.zig remove run debug messages in versionstep 2022-05-28 17:58:20 -07:00
zfetch_deps.zig dig out aws crt. project no longer builds 2022-01-10 21:49:59 -08:00

README.md

AWS SDK for Zig

Build Status

This SDK currently supports all AWS services except S3. See TODO list below.

Current executable size for the demo is 1.7M (90k of which is the AWS PEM file, and approximately 600K for XML services) after compiling with -Drelease-safe and stripping the executable after compilation. This is for x86_linux, and will vary based on services used. Tested targets:

  • x86_64-linux
  • riscv64-linux
  • aarch64-linux
  • x86_64-windows
  • arm-linux
  • aarch64-macos
  • x86_64-macos

Tested targets are built, but not continuously tested, by CI.

Building

zig build should work. It will build the code generation project, run the code generation, then build the main project with the generated code.

First time build should use zig build -Dfetch to fetch dependent packages (zfetch and friends).

Running

This library mimics the aws c libraries for it's work, so it operates like most other 'AWS things'. main.zig gives you a handful of examples for working with services. For local testing or alternative endpoints, there's no real standard, so there is code to look for AWS_ENDPOINT_URL environment variable that will supersede all other configuration. Note that an alternative endpoint may require passing in a client option to specify an different TLS root certificate (pass null to disable certificate verification).

The old branch exists for posterity, and supports x86_64 linux. The old branch is deprecated.

Limitations

There are many nuances of AWS V4 signature calculation. S3 is not supported because it uses many of these edge cases. Also endpoint calculation is special for S3. WebIdentityToken is not yet implemented.

TODO List:

  • Implement initial S3 support. This involves:
    • Implementation of AWS SigV4 signature calculation for S3, which is unique
    • Implementation of S3 endpoint calculation, which is also unique to this service
  • Bump to zig 0.9.1. iguanaTLS, used in zFetch is still working out 0.9.1 issues
  • Implement sigv4a signing
  • Implement jitter/exponential backoff
  • Implement timeouts and other TODO's in the code
  • Add option to cache signature keys

Compiler wishlist/watchlist: