Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Encode API key as base64 in common code #18945

Merged
merged 9 commits into from
Jun 9, 2020
+89 −13
Merged

Encode API key as base64 in common code #18945

Show file tree
Hide file tree
Changes from 1 commit
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 Jun 3, 2020
afa3e91
Adding comment on API key field
ycombinator Jun 3, 2020
218145f
Adding CHANGELOG entries
ycombinator Jun 3, 2020
4afdf11
Adding test
ycombinator Jun 3, 2020
36a5b81
Base64-encode API key in constructor
ycombinator Jun 4, 2020
97806e0
Move encodedAPIKey field to Connection
ycombinator Jun 4, 2020
dce0e2a
Update doc on `api_key` setting value
ycombinator Jun 4, 2020
2eb7a5f
Adding API key format to setting section
ycombinator Jun 5, 2020
9982b8d
Compute entire API key auth header value up front
ycombinator Jun 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Encode API key as base64 in common code
  • Loading branch information
@ycombinator
ycombinator committed Jun 5, 2020
commit 559eb3ef20cd59ac7e260b4e00b9e0eb2379aedf
4 changes: 3 additions & 1 deletion libbeat/esleg/eslegclient/connection.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package eslegclient

import (
"encoding/base64"
"encoding/json"
"fmt"
"io"
Expand Down Expand Up @@ -436,7 +437,8 @@ func (conn *Connection) execHTTPRequest(req *http.Request) (int, []byte, error)
}

if conn.APIKey != "" {
req.Header.Add("Authorization", "ApiKey "+conn.APIKey)
encoded := base64.StdEncoding.EncodeToString([]byte(conn.APIKey))
req.Header.Add("Authorization", "ApiKey "+encoded)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it make sense to cache the result in a private variable like conn.encodedAPIKey ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it would. No need to encode it each time we make a request to ES. Thanks for the suggestion, will implement!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in c3e5b43.

}

for name, value := range conn.Headers {
Expand Down
3 changes: 1 addition & 2 deletions libbeat/outputs/elasticsearch/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package elasticsearch

import (
"context"
"encoding/base64"
"errors"
"fmt"
"net/http"
Expand Down Expand Up @@ -84,7 +83,7 @@ func NewClient(
URL: s.URL,
Username: s.Username,
Password: s.Password,
APIKey: base64.StdEncoding.EncodeToString([]byte(s.APIKey)),
APIKey: s.APIKey,
Headers: s.Headers,
TLS: s.TLS,
Kerberos: s.Kerberos,
Expand Down