gitlab-com-seaweedfs/seaweedfs
1
0
Fork 0
mirror of https://github.com/seaweedfs/seaweedfs.git synced 2024-01-19 02:48:24 +00:00
Code Issues Projects Releases Wiki Activity

docs(s3api): readability improvements (#3696)

Browse source 
Signed-off-by: Ryan Russell <git@ryanrussell.org>

Signed-off-by: Ryan Russell <git@ryanrussell.org>
This commit is contained in:
Ryan Russell 2022-09-15 05:13:21 -05:00 committed by GitHub
parent ad3a3c8782
commit 6f7ef8711a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
weed/s3api/auth_signature_v2.go
View file

@ -119,7 +119,7 @@ func validateV2AuthHeader(v2Auth string) (accessKey string, errCode s3err.ErrorC
return "", s3err.ErrMissingFields return "", s3err.ErrMissingFields
} }
// Then will be splitting on ":", this will seprate `AWSAccessKeyId` and `Signature` string. // Then will be splitting on ":", this will separate `AWSAccessKeyId` and `Signature` string.
keySignFields := strings.Split(strings.TrimSpace(authFields[1]), ":") keySignFields := strings.Split(strings.TrimSpace(authFields[1]), ":")
if len(keySignFields) != 2 { if len(keySignFields) != 2 {
return "", s3err.ErrMissingFields return "", s3err.ErrMissingFields

6
weed/s3api/auth_signature_v4.go
View file

@ -225,7 +225,7 @@ func parseSignV4(v4Auth string) (sv signValues, aec s3err.ErrorCode) {
signV4Values := signValues{} signV4Values := signValues{}
var err s3err.ErrorCode var err s3err.ErrorCode
// Save credentail values. // Save credential values.
signV4Values.Credential, err = parseCredentialHeader(authFields[0]) signV4Values.Credential, err = parseCredentialHeader(authFields[0])
if err != s3err.ErrNone { if err != s3err.ErrNone {
return sv, err return sv, err
@ -467,7 +467,7 @@ func contains(list []string, elem string) bool {
return false return false
} }
// preSignValues data type represents structued form of AWS Signature V4 query string. // preSignValues data type represents structured form of AWS Signature V4 query string.
type preSignValues struct { type preSignValues struct {
signValues signValues
Date time.Time Date time.Time
@ -551,7 +551,7 @@ func parsePreSignV4(query url.Values) (psv preSignValues, aec s3err.ErrorCode) {
return psv, err return psv, err
} }
// Return structed form of signature query string. // Return structured form of signature query string.
return preSignV4Values, s3err.ErrNone return preSignV4Values, s3err.ErrNone
} }

6
weed/s3api/auto_signature_v4_test.go
View file

@ -21,7 +21,7 @@ import (
"github.com/seaweedfs/seaweedfs/weed/s3api/s3err" "github.com/seaweedfs/seaweedfs/weed/s3api/s3err"
) )
// TestIsRequestPresignedSignatureV4 - Test validates the logic for presign signature verision v4 detection. // TestIsRequestPresignedSignatureV4 - Test validates the logic for presign signature version v4 detection.
func TestIsRequestPresignedSignatureV4(t *testing.T) { func TestIsRequestPresignedSignatureV4(t *testing.T) {
testCases := []struct { testCases := []struct {
inputQueryKey string inputQueryKey string
@ -138,7 +138,7 @@ func mustNewSignedRequest(method string, urlStr string, contentLength int64, bod
req := mustNewRequest(method, urlStr, contentLength, body, t) req := mustNewRequest(method, urlStr, contentLength, body, t)
cred := &Credential{"access_key_1", "secret_key_1"} cred := &Credential{"access_key_1", "secret_key_1"}
if err := signRequestV4(req, cred.AccessKey, cred.SecretKey); err != nil { if err := signRequestV4(req, cred.AccessKey, cred.SecretKey); err != nil {
t.Fatalf("Unable to inititalized new signed http request %s", err) t.Fatalf("Unable to initialized new signed http request %s", err)
} }
return req return req
} }
@ -149,7 +149,7 @@ func mustNewPresignedRequest(method string, urlStr string, contentLength int64,
req := mustNewRequest(method, urlStr, contentLength, body, t) req := mustNewRequest(method, urlStr, contentLength, body, t)
cred := &Credential{"access_key_1", "secret_key_1"} cred := &Credential{"access_key_1", "secret_key_1"}
if err := preSignV4(req, cred.AccessKey, cred.SecretKey, int64(10*time.Minute.Seconds())); err != nil { if err := preSignV4(req, cred.AccessKey, cred.SecretKey, int64(10*time.Minute.Seconds())); err != nil {
t.Fatalf("Unable to inititalized new signed http request %s", err) t.Fatalf("Unable to initialized new signed http request %s", err)
} }
return req return req
} }

2
weed/s3api/chunked_reader_v4.go
View file

@ -135,7 +135,7 @@ func (iam *IdentityAccessManagement) calculateSeedSignature(r *http.Request) (cr
return nil, "", "", time.Time{}, s3err.ErrSignatureDoesNotMatch return nil, "", "", time.Time{}, s3err.ErrSignatureDoesNotMatch
} }
// Return caculated signature. // Return calculated signature.
return cred, newSignature, region, date, s3err.ErrNone return cred, newSignature, region, date, s3err.ErrNone
} }

2
weed/s3api/policy/post-policy_test.go
View file

@ -125,7 +125,7 @@ func newPostPolicyBytesV2(bucketName, objectKey string, expiration time.Time) []
// postPresignSignatureV4 - presigned signature for PostPolicy requests. // postPresignSignatureV4 - presigned signature for PostPolicy requests.
func postPresignSignatureV4(policyBase64 string, t time.Time, secretAccessKey, location string) string { func postPresignSignatureV4(policyBase64 string, t time.Time, secretAccessKey, location string) string {
// Get signining key. // Get signing key.
signingkey := getSigningKey(secretAccessKey, t, location) signingkey := getSigningKey(secretAccessKey, t, location)
// Calculate signature. // Calculate signature.
signature := getSignature(signingkey, policyBase64) signature := getSignature(signingkey, policyBase64)

2
weed/s3api/policy/postpolicyform.go
View file

@ -203,7 +203,7 @@ func ParsePostPolicyForm(policy string) (ppf PostPolicyForm, e error) {
return parsedPolicy, nil return parsedPolicy, nil
} }
// checkPolicyCond returns a boolean to indicate if a condition is satisified according // checkPolicyCond returns a boolean to indicate if a condition is satisfied according
// to the passed operator // to the passed operator
func checkPolicyCond(op string, input1, input2 string) bool { func checkPolicyCond(op string, input1, input2 string) bool {
switch op { switch op {