-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Encode API key as base64 in common code #18945
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
559eb3e
Encode API key as base64 in common code
ycombinator afa3e91
Adding comment on API key field
ycombinator 218145f
Adding CHANGELOG entries
ycombinator 4afdf11
Adding test
ycombinator 36a5b81
Base64-encode API key in constructor
ycombinator 97806e0
Move encodedAPIKey field to Connection
ycombinator dce0e2a
Update doc on `api_key` setting value
ycombinator 2eb7a5f
Adding API key format to setting section
ycombinator 9982b8d
Compute entire API key auth header value up front
ycombinator File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
// Licensed to Elasticsearch B.V. under one or more contributor | ||
// license agreements. See the NOTICE file distributed with | ||
// this work for additional information regarding copyright | ||
// ownership. Elasticsearch B.V. licenses this file to you under | ||
// the Apache License, Version 2.0 (the "License"); you may | ||
// not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, | ||
// software distributed under the License is distributed on an | ||
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
// KIND, either express or implied. See the License for the | ||
// specific language governing permissions and limitations | ||
// under the License. | ||
|
||
package eslegclient | ||
|
||
import ( | ||
"bufio" | ||
"bytes" | ||
"encoding/base64" | ||
"net/http" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestAPIKeyEncoding(t *testing.T) { | ||
apiKey := "foobar" | ||
encoded := base64.StdEncoding.EncodeToString([]byte(apiKey)) | ||
|
||
conn, err := NewConnection(ConnectionSettings{ | ||
APIKey: apiKey, | ||
}) | ||
require.NoError(t, err) | ||
|
||
httpClient := newMockClient() | ||
conn.HTTP = httpClient | ||
|
||
req, err := http.NewRequest("GET", "http://fakehost/some/path", nil) | ||
require.NoError(t, err) | ||
|
||
_, _, err = conn.execHTTPRequest(req) | ||
require.NoError(t, err) | ||
|
||
require.Equal(t, "ApiKey "+encoded, httpClient.Req.Header.Get("Authorization")) | ||
} | ||
|
||
type mockClient struct { | ||
Req *http.Request | ||
} | ||
|
||
func (c *mockClient) Do(req *http.Request) (*http.Response, error) { | ||
c.Req = req | ||
|
||
r := bytes.NewReader([]byte("HTTP/1.1 200 OK\n\nHello, world")) | ||
return http.ReadResponse(bufio.NewReader(r), req) | ||
} | ||
|
||
func (c *mockClient) CloseIdleConnections() {} | ||
|
||
func newMockClient() *mockClient { | ||
return &mockClient{} | ||
} |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This info would be good down on line 137 with the
api_key
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 42d288616.