A Clojure library to pre-signed URLs (S3) and sign HTTP requests for AWS. The library only depends on Java core (no external Java dependencies), making it fairly light.
If you stumble upon problems, feel free to reach out either by creating an issue or ping me via Clojurian Slack.
Include the dependency in your project:
The library needs "client" information containing credentials etc.
Both Cognitect AWS API client and awyeah can produce compatible clients.
These clients will look for credentials in all the usual places
honoring how AWS specific environment variables and configuration,
except for endpoint which needs to be provided in code (see :endpoint-override
below).
💡 Only
awyeah-api
works with Babashka at the time of writing.
The following example uses the awyeah-api
lib.
(require '[com.grzm.awyeah.client.api :as aws])
(def client
(aws/client {:api :s3
;; :endpoint-override is commented out
;; and usually only relevant for non-Amazon or local setups
#_#_:endpoint-override {:protocol :http
:hostname "localhost"
:port 9000}))
Alternatively, the same data structure can be provided manually:
(def client
{:credentials #:aws{:access-key-id "some-access-key"
:secret-access-key "wild_secr3t"
:session-token "FwoG..."}
:region "us-east-1"
:endpoint {:protocol :https
:hostname "s3.amazonaws.com"}})
To generate a pre-signed URL for a S3 object:
(require '[aws-simple-sign.core :as aws])
(aws/generate-presigned-url client "somebucket" "someobject.txt" {})
"https://somebucket.s3.us-east-1.amazonaws.com/someobject.txt?X-Amz-Security-Token=FwoG..."
By default, the URLs returned will use "virtual hosted-style".
But having an S3 bucket with dots (.
) in the name, the SSL certificate cannot be verified.
This can cause many types of errors depending on the code consuming the URL, but one could be:
No subject alternative DNS name matching
To avoid this problem, it is possible to generate URLs using "path style" instead. This, of course, has its own disadvantages but can be a way out when it is impossible to rename the bucket.
(aws/generate-presigned-url client "somebucket" "someobject.txt" {:path-style true})
"https://s3.us-east-1.amazonaws.com/somebucket/someobject.txt?X-Amz-Security-Token=FwoG..."
For more information about "virtual hosted vs. path style" in the official announcements:
The following example illustrates how signing can be used from within a Babashka script:
(require '[aws-simple-sign.core :as aws])
(require '[babashka.http-client :as http])
(let [signed-request (-> {:url "https://someurl/some-api-endpoint"
:method :post
:headers {"accept" "application/json"}
:body "{\"somekey\": \"with some value\"}"}
(aws/sign-request {:region "us-west-1"}))]
(http/post (:url signed-request)
(-> signed-request
(select-keys [:body :headers]))))
Can you improve this documentation?Edit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close