-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
892cc2e
commit bc65545
Showing
27 changed files
with
783 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| // Package sas implements functionality for creating and verifying shared access | ||
| // signatures (SAS) and shared access tokens (SAT) as well as using them to | ||
| // query Axiom datasets. A SAS grants querying capabilities to a dataset for a | ||
| // given time range and with a global filter applied on behalf of an | ||
| // organization. A SAS is an URL query string composed of a set of query | ||
| // parameters that make up the payload for a signature and the cryptographic | ||
| // signature itself. That cryptographic signature is called SAT. | ||
| // | ||
| // Usage: | ||
| // | ||
| // import "github.com/axiomhq/axiom-go/axiom/sas" | ||
| // | ||
| // To create a SAS, that can be attached to a query request, use the | ||
| // high-level [Create] function. The returned [Options] can be attached to a | ||
| // [http.Request] or encoded to a query string by calling [Options.Encode]. | ||
| package sas |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| package sas | ||
|
|
||
| import ( | ||
| "errors" | ||
| "net/http" | ||
| "net/url" | ||
|
|
||
| "github.com/google/go-querystring/query" | ||
| ) | ||
|
|
||
| // The parameter names for the shared access signature query string. | ||
| const ( | ||
| queryOrgID = "oi" | ||
| queryDataset = "dt" | ||
| queryFilter = "fl" | ||
| queryMinStartTime = "mst" | ||
| queryMaxEndTime = "met" | ||
| queryExpiryTime = "exp" | ||
| queryToken = "tk" | ||
| ) | ||
|
|
||
| // Options are the url query parameters used to authenticate a query request. | ||
| type Options struct { | ||
| Params | ||
|
|
||
| // Token is the signature created from the other fields in the options. | ||
| Token string `url:"tk"` | ||
| } | ||
|
|
||
| // Decode decodes the given signature into a set of options. | ||
| func Decode(signature string) (Options, error) { | ||
| q, err := url.ParseQuery(signature) | ||
| if err != nil { | ||
| return Options{}, err | ||
| } | ||
|
|
||
| options := Options{ | ||
| Params: Params{ | ||
| OrganizationID: q.Get(queryOrgID), | ||
| Dataset: q.Get(queryDataset), | ||
| Filter: q.Get(queryFilter), | ||
| MinStartTime: q.Get(queryMinStartTime), | ||
| MaxEndTime: q.Get(queryMaxEndTime), | ||
| ExpiryTime: q.Get(queryExpiryTime), | ||
| }, | ||
| Token: q.Get(queryToken), | ||
| } | ||
|
|
||
| // Validate that the params are valid and the token is present. | ||
| if err := options.Params.Validate(); err != nil { | ||
| return options, err | ||
| } else if options.Token == "" { | ||
| return options, errors.New("missing token") | ||
| } | ||
|
|
||
| return options, nil | ||
| } | ||
|
|
||
| // Attach attaches the options to the given request as a query string. Existing | ||
| // query parameters are retained unless they are overwritten by the key of one | ||
| // of the options. | ||
| func (o Options) Attach(req *http.Request) error { | ||
| q, err := query.Values(o) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| qc := req.URL.Query() | ||
| for k := range q { | ||
| qc.Set(k, q.Get(k)) | ||
| } | ||
| req.URL.RawQuery = qc.Encode() | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Encode encodes the options into a url query string. | ||
| func (o Options) Encode() (string, error) { | ||
| q, err := query.Values(o) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // Although officially there is no limit specified by RFC 2616, many | ||
| // security protocols and recommendations state that maxQueryStrings on a | ||
| // server should be set to a maximum character limit of 1024. While the | ||
| // entire URL, including the querystring, should be set to a max of 2048 | ||
| // characters. | ||
| s := q.Encode() | ||
| if len(s) > 1023 { // 1024 - 1 for '?' | ||
| return "", errors.New("signature too long") | ||
| } | ||
|
|
||
| return s, nil | ||
| } |
Oops, something went wrong.