lobo/aws-sdk-for-zig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

update README with new XML information
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Emil Lerch 2022-02-10 15:29:51 -08:00
parent f374df3fa1
commit ca801799fc
Signed by: lobo
GPG Key ID: A7B62D657EF764F8
1 changed files with 15 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -2,13 +2,11 @@
[![Build Status](https://drone.lerch.org/api/badges/lobo/aws-sdk-for-zig/status.svg?ref=refs/heads/master)](https://drone.lerch.org/api/badges/lobo/aws-sdk-for-zig/) [![Build Status](https://drone.lerch.org/api/badges/lobo/aws-sdk-for-zig/status.svg?ref=refs/heads/master)](https://drone.lerch.org/api/badges/lobo/aws-sdk-for-zig/)
### NOTE: All tests pass, but credentials currently must be passed through environment
This SDK currently supports all AWS services except EC2 and S3. These two This SDK currently supports all AWS services except EC2 and S3. These two
services only support XML, and zig 0.8.0 and master both trigger compile services only support XML, and zig 0.9.0 and master both trigger compile
errors while incorporating the XML parser. S3 also requires some plumbing errors while incorporating the XML parser in conjunction with a process
tweaks in the signature calculation. Examples of usage are in src/main.zig. to fill the types. S3 also requires some plumbing tweaks in the signature
calculation. Examples of usage are in src/main.zig.
Current executable size for the demo is 953k (90k of which is the AWS PEM file) Current executable size for the demo is 953k (90k of which is the AWS PEM file)
after compiling with -Drelease-safe and after compiling with -Drelease-safe and
@ -43,31 +41,28 @@ supersede all other configuration. Note that an alternative endpoint may
require passing in a client option to specify an different TLS root certificate require passing in a client option to specify an different TLS root certificate
(pass null to disable certificate verification). (pass null to disable certificate verification).
Given that credential handling is still very basic, you may want to look at The [old branch](https://github.com/elerch/aws-sdk-for-zig/tree/aws-crt) exists
the [old branch](https://github.com/elerch/aws-sdk-for-zig/tree/aws-crt) if for posterity, and supports x86_64 linux. This branch is recommended moving
your needs include something more robust. Note that that branch supports forward.
x86_64 linux only.
## Limitations ## Limitations
There are many nuances of AWS V4 signature calculation. S3 is not supported There are many nuances of AWS V4 signature calculation. S3 is not supported
because it uses many of these test cases. STS tokens using a session token because it uses many of these test cases. WebIdentityToken is not yet
are not yet implemented, though should be trivial. I have also seen a few implemented.
service errors caused by discrepancies in signatures, though I don't know yet
if this was an issue in the service itself (has not repro'd) or if there
is a latent bug.
Only environment variable based credentials can be used at the moment.
TODO List: TODO List:
* To work around compiler issues, the best option may be to convert from
Xml to json, then parse from there. This will be pursued first. It may need
to wait for zig 0.10.0 when self-hosted compiler is likely to be completed
(zig 0.10.0 eta May 2022) discovered. If we need to wait, S3, EC2 and other
restXml protocols will be blocked.
* Implement [AWS restXml protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-restxml-protocol.html). * Implement [AWS restXml protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-restxml-protocol.html).
Includes S3. Total service count 4. This may be blocked due to the same issue as EC2. Includes S3. Total service count 4. This may be blocked due to the same issue as EC2.
* Implement [AWS EC2 query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-ec2-query-protocol.html). * Implement [AWS EC2 query protocol](https://awslabs.github.io/smithy/1.0/spec/aws/aws-ec2-query-protocol.html).
Includes EC2. Total service count 1. This may be blocked on a compiler bug, Includes EC2. Total service count 1. This may be blocked on a compiler bug,
though has not been tested with zig 0.9.0. It may need to wait for zig 0.10.0 though has not been tested with zig 0.9.0. More details and llvm ir log can be found in the
when self-hosted compiler is likely to be completed (zig 0.10.0 eta May 2022)
discovered. More details and llvm ir log can be found in the
[XML branch](https://git.lerch.org/lobo/aws-sdk-for-zig/src/branch/xml). [XML branch](https://git.lerch.org/lobo/aws-sdk-for-zig/src/branch/xml).
* Implement sigv4a signing * Implement sigv4a signing
* Implement jitter/exponential backoff * Implement jitter/exponential backoff