Add support for AssumeRoleWithWebIdentity (#6985)
Harshavardhana
6 years ago
committed by
kannappanr
parent
e82dcd195c
commit
2d19011a1d
@ -0,0 +1,143 @@ |
||||
/* |
||||
* Minio Cloud Storage, (C) 2018 Minio, Inc. |
||||
* |
||||
* Licensed 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 cmd |
||||
|
||||
import ( |
||||
"encoding/xml" |
||||
|
||||
"github.com/minio/minio/pkg/auth" |
||||
) |
||||
|
||||
// AssumedRoleUser - The identifiers for the temporary security credentials that
|
||||
// the operation returns. Please also see https://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumedRoleUser
|
||||
type AssumedRoleUser struct { |
||||
// The ARN of the temporary security credentials that are returned from the
|
||||
// AssumeRole action. For more information about ARNs and how to use them in
|
||||
// policies, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
|
||||
// in Using IAM.
|
||||
//
|
||||
// Arn is a required field
|
||||
Arn string |
||||
|
||||
// A unique identifier that contains the role ID and the role session name of
|
||||
// the role that is being assumed. The role ID is generated by AWS when the
|
||||
// role is created.
|
||||
//
|
||||
// AssumedRoleId is a required field
|
||||
AssumedRoleID string `xml:"AssumeRoleId"` |
||||
// contains filtered or unexported fields
|
||||
} |
||||
|
||||
// AssumeRoleWithWebIdentityResponse contains the result of successful AssumeRoleWithWebIdentity request.
|
||||
type AssumeRoleWithWebIdentityResponse struct { |
||||
XMLName xml.Name `xml:"https://sts.amazonaws.com/doc/2011-06-15/ AssumeRoleWithWebIdentityResponse" json:"-"` |
||||
Result WebIdentityResult `xml:"AssumeRoleWithWebIdentityResult"` |
||||
ResponseMetadata struct { |
||||
RequestID string `xml:"RequestId,omitempty"` |
||||
} `xml:"ResponseMetadata,omitempty"` |
||||
} |
||||
|
||||
// WebIdentityResult - Contains the response to a successful AssumeRoleWithWebIdentity
|
||||
// request, including temporary credentials that can be used to make Minio API requests.
|
||||
type WebIdentityResult struct { |
||||
// The identifiers for the temporary security credentials that the operation
|
||||
// returns.
|
||||
AssumedRoleUser AssumedRoleUser `xml:",omitempty"` |
||||
|
||||
// The intended audience (also known as client ID) of the web identity token.
|
||||
// This is traditionally the client identifier issued to the application that
|
||||
// requested the client grants.
|
||||
Audience string `xml:",omitempty"` |
||||
|
||||
// The temporary security credentials, which include an access key ID, a secret
|
||||
// access key, and a security (or session) token.
|
||||
//
|
||||
// Note: The size of the security token that STS APIs return is not fixed. We
|
||||
// strongly recommend that you make no assumptions about the maximum size. As
|
||||
// of this writing, the typical size is less than 4096 bytes, but that can vary.
|
||||
// Also, future updates to AWS might require larger sizes.
|
||||
Credentials auth.Credentials `xml:",omitempty"` |
||||
|
||||
// A percentage value that indicates the size of the policy in packed form.
|
||||
// The service rejects any policy with a packed size greater than 100 percent,
|
||||
// which means the policy exceeded the allowed space.
|
||||
PackedPolicySize int `xml:",omitempty"` |
||||
|
||||
// The issuing authority of the web identity token presented. For OpenID Connect
|
||||
// ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens,
|
||||
// this contains the value of the ProviderId parameter that was passed in the
|
||||
// AssumeRoleWithWebIdentity request.
|
||||
Provider string `xml:",omitempty"` |
||||
|
||||
// The unique user identifier that is returned by the identity provider.
|
||||
// This identifier is associated with the Token that was submitted
|
||||
// with the AssumeRoleWithWebIdentity call. The identifier is typically unique to
|
||||
// the user and the application that acquired the WebIdentityToken (pairwise identifier).
|
||||
// For OpenID Connect ID tokens, this field contains the value returned by the identity
|
||||
// provider as the token's sub (Subject) claim.
|
||||
SubjectFromWebIdentityToken string `xml:",omitempty"` |
||||
} |
||||
|
||||
// AssumeRoleWithClientGrantsResponse contains the result of successful AssumeRoleWithClientGrants request.
|
||||
type AssumeRoleWithClientGrantsResponse struct { |
||||
XMLName xml.Name `xml:"https://sts.amazonaws.com/doc/2011-06-15/ AssumeRoleWithClientGrantsResponse" json:"-"` |
||||
Result ClientGrantsResult `xml:"AssumeRoleWithClientGrantsResult"` |
||||
ResponseMetadata struct { |
||||
RequestID string `xml:"RequestId,omitempty"` |
||||
} `xml:"ResponseMetadata,omitempty"` |
||||
} |
||||
|
||||
// ClientGrantsResult - Contains the response to a successful AssumeRoleWithClientGrants
|
||||
// request, including temporary credentials that can be used to make Minio API requests.
|
||||
type ClientGrantsResult struct { |
||||
// The identifiers for the temporary security credentials that the operation
|
||||
// returns.
|
||||
AssumedRoleUser AssumedRoleUser `xml:",omitempty"` |
||||
|
||||
// The intended audience (also known as client ID) of the web identity token.
|
||||
// This is traditionally the client identifier issued to the application that
|
||||
// requested the client grants.
|
||||
Audience string `xml:",omitempty"` |
||||
|
||||
// The temporary security credentials, which include an access key ID, a secret
|
||||
// access key, and a security (or session) token.
|
||||
//
|
||||
// Note: The size of the security token that STS APIs return is not fixed. We
|
||||
// strongly recommend that you make no assumptions about the maximum size. As
|
||||
// of this writing, the typical size is less than 4096 bytes, but that can vary.
|
||||
// Also, future updates to AWS might require larger sizes.
|
||||
Credentials auth.Credentials `xml:",omitempty"` |
||||
|
||||
// A percentage value that indicates the size of the policy in packed form.
|
||||
// The service rejects any policy with a packed size greater than 100 percent,
|
||||
// which means the policy exceeded the allowed space.
|
||||
PackedPolicySize int `xml:",omitempty"` |
||||
|
||||
// The issuing authority of the web identity token presented. For OpenID Connect
|
||||
// ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens,
|
||||
// this contains the value of the ProviderId parameter that was passed in the
|
||||
// AssumeRoleWithClientGrants request.
|
||||
Provider string `xml:",omitempty"` |
||||
|
||||
// The unique user identifier that is returned by the identity provider.
|
||||
// This identifier is associated with the Token that was submitted
|
||||
// with the AssumeRoleWithClientGrants call. The identifier is typically unique to
|
||||
// the user and the application that acquired the ClientGrantsToken (pairwise identifier).
|
||||
// For OpenID Connect ID tokens, this field contains the value returned by the identity
|
||||
// provider as the token's sub (Subject) claim.
|
||||
SubjectFromToken string `xml:",omitempty"` |
||||
} |
||||
@ -0,0 +1,178 @@ |
||||
// +build ignore
|
||||
|
||||
/* |
||||
* Minio Cloud Storage, (C) 2018 Minio, Inc. |
||||
* |
||||
* Licensed 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 main |
||||
|
||||
import ( |
||||
"context" |
||||
"crypto/rand" |
||||
"encoding/base64" |
||||
"encoding/json" |
||||
"encoding/xml" |
||||
"flag" |
||||
"fmt" |
||||
"log" |
||||
"net/http" |
||||
"net/url" |
||||
"time" |
||||
|
||||
"golang.org/x/oauth2" |
||||
googleOAuth2 "golang.org/x/oauth2/google" |
||||
|
||||
"github.com/minio/minio/pkg/auth" |
||||
) |
||||
|
||||
// AssumedRoleUser - The identifiers for the temporary security credentials that
|
||||
// the operation returns. Please also see https://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumedRoleUser
|
||||
type AssumedRoleUser struct { |
||||
Arn string |
||||
AssumedRoleID string `xml:"AssumeRoleId"` |
||||
// contains filtered or unexported fields
|
||||
} |
||||
|
||||
// AssumeRoleWithWebIdentityResponse contains the result of successful AssumeRoleWithWebIdentity request.
|
||||
type AssumeRoleWithWebIdentityResponse struct { |
||||
XMLName xml.Name `xml:"https://sts.amazonaws.com/doc/2011-06-15/ AssumeRoleWithWebIdentityResponse" json:"-"` |
||||
Result WebIdentityResult `xml:"AssumeRoleWithWebIdentityResult"` |
||||
ResponseMetadata struct { |
||||
RequestID string `xml:"RequestId,omitempty"` |
||||
} `xml:"ResponseMetadata,omitempty"` |
||||
} |
||||
|
||||
// WebIdentityResult - Contains the response to a successful AssumeRoleWithWebIdentity
|
||||
// request, including temporary credentials that can be used to make Minio API requests.
|
||||
type WebIdentityResult struct { |
||||
AssumedRoleUser AssumedRoleUser `xml:",omitempty"` |
||||
Audience string `xml:",omitempty"` |
||||
Credentials auth.Credentials `xml:",omitempty"` |
||||
PackedPolicySize int `xml:",omitempty"` |
||||
Provider string `xml:",omitempty"` |
||||
SubjectFromWebIdentityToken string `xml:",omitempty"` |
||||
} |
||||
|
||||
// Returns a base64 encoded random 32 byte string.
|
||||
func randomState() string { |
||||
b := make([]byte, 32) |
||||
rand.Read(b) |
||||
return base64.RawURLEncoding.EncodeToString(b) |
||||
} |
||||
|
||||
var ( |
||||
stsEndpoint string |
||||
authEndpoint string |
||||
tokenEndpoint string |
||||
clientID string |
||||
clientSecret string |
||||
) |
||||
|
||||
func init() { |
||||
flag.StringVar(&stsEndpoint, "sts-ep", "http://localhost:9000", "STS endpoint") |
||||
flag.StringVar(&authEndpoint, "auth-ep", googleOAuth2.Endpoint.AuthURL, "Auth endpoint") |
||||
flag.StringVar(&tokenEndpoint, "token-ep", googleOAuth2.Endpoint.TokenURL, "Token endpoint") |
||||
flag.StringVar(&clientID, "cid", "", "Client ID") |
||||
flag.StringVar(&clientSecret, "csec", "", "Client secret") |
||||
} |
||||
|
||||
func main() { |
||||
flag.Parse() |
||||
if clientID == "" || clientSecret == "" { |
||||
flag.PrintDefaults() |
||||
return |
||||
} |
||||
|
||||
ctx := context.Background() |
||||
|
||||
config := oauth2.Config{ |
||||
ClientID: clientID, |
||||
ClientSecret: clientSecret, |
||||
Endpoint: oauth2.Endpoint{ |
||||
AuthURL: authEndpoint, |
||||
TokenURL: tokenEndpoint, |
||||
}, |
||||
RedirectURL: "http://localhost:8080/oauth2/callback", |
||||
Scopes: []string{"openid", "profile", "email"}, |
||||
} |
||||
|
||||
state := randomState() |
||||
|
||||
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { |
||||
http.Redirect(w, r, config.AuthCodeURL(state), http.StatusFound) |
||||
}) |
||||
|
||||
http.HandleFunc("/oauth2/callback", func(w http.ResponseWriter, r *http.Request) { |
||||
if r.URL.Query().Get("state") != state { |
||||
http.Error(w, "state did not match", http.StatusBadRequest) |
||||
return |
||||
} |
||||
|
||||
oauth2Token, err := config.Exchange(ctx, r.URL.Query().Get("code")) |
||||
if err != nil { |
||||
http.Error(w, "Failed to exchange token: "+err.Error(), http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
if oauth2Token.Valid() { |
||||
v := url.Values{} |
||||
v.Set("Action", "AssumeRoleWithWebIdentity") |
||||
v.Set("WebIdentityToken", fmt.Sprintf("%s", oauth2Token.Extra("id_token"))) |
||||
v.Set("DurationSeconds", fmt.Sprintf("%d", int64(oauth2Token.Expiry.Sub(time.Now().UTC()).Seconds()))) |
||||
v.Set("Version", "2011-06-15") |
||||
|
||||
u, err := url.Parse("http://localhost:9000") |
||||
if err != nil { |
||||
http.Error(w, err.Error(), http.StatusInternalServerError) |
||||
return |
||||
} |
||||
u.RawQuery = v.Encode() |
||||
|
||||
req, err := http.NewRequest("POST", u.String(), nil) |
||||
if err != nil { |
||||
http.Error(w, err.Error(), http.StatusInternalServerError) |
||||
return |
||||
} |
||||
resp, err := http.DefaultClient.Do(req) |
||||
if err != nil { |
||||
http.Error(w, err.Error(), http.StatusInternalServerError) |
||||
return |
||||
|
||||
} |
||||
defer resp.Body.Close() |
||||
if resp.StatusCode != http.StatusOK { |
||||
http.Error(w, resp.Status, resp.StatusCode) |
||||
return |
||||
} |
||||
|
||||
a := AssumeRoleWithWebIdentityResponse{} |
||||
if err = xml.NewDecoder(resp.Body).Decode(&a); err != nil { |
||||
http.Error(w, err.Error(), http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
w.Write([]byte("##### Credentials\n")) |
||||
c, err := json.MarshalIndent(a.Result.Credentials, "", "\t") |
||||
if err != nil { |
||||
http.Error(w, err.Error(), http.StatusInternalServerError) |
||||
return |
||||
} |
||||
w.Write(c) |
||||
} |
||||
}) |
||||
|
||||
log.Printf("listening on http://%s/", "localhost:8080") |
||||
log.Fatal(http.ListenAndServe("localhost:8080", nil)) |
||||
} |
||||
@ -0,0 +1,88 @@ |
||||
## AssumeRoleWithWebIdentity [](https://slack.minio.io) |
||||
Calling AssumeRoleWithWebIdentity does not require the use of Minio default credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including Minio default credentials in the application. Instead, the identity of the caller is validated by using a JWT access token from the web identity provider. The temporary security credentials returned by this API consist of an access key, a secret key, and a security token. Applications can use these temporary security credentials to sign calls to Minio API operations. |
||||
|
||||
By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, use the optional DurationSeconds parameter to specify the duration of the credentials. This value varies from 900 seconds (15 minutes) up to the maximum session duration to 12 hours. |
||||
|
||||
### Request Parameters |
||||
#### DurationSeconds |
||||
The duration, in seconds. The value can range from 900 seconds (15 minutes) up to the 12 hours. If value is higher than this setting, then operation fails. By default, the value is set to 3600 seconds. |
||||
|
||||
| Params | Value | |
||||
| :-- | :-- | |
||||
| *Type* | *Integer* | |
||||
| *Valid Range* | *Minimum value of 900. Maximum value of 43200.* | |
||||
| *Required* | *No* | |
||||
|
||||
#### WebIdentityToken |
||||
The OAuth 2.0 access token that is provided by the web identity provider. Application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call. |
||||
|
||||
| Params | Value | |
||||
| :-- | :-- | |
||||
| *Type* | *String* | |
||||
| *Length Constraints* | *Minimum length of 4. Maximum length of 2048.* | |
||||
| *Required* | *Yes* | |
||||
|
||||
#### Response Elements |
||||
XML response for this API is similar to [AWS STS AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html#API_AssumeRoleWithWebIdentity_ResponseElements) |
||||
|
||||
#### Errors |
||||
XML error response for this API is similar to [AWS STS AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html#API_AssumeRoleWithWebIdentity_Errors) |
||||
|
||||
#### Sample Request |
||||
``` |
||||
http://minio.cluster:9000?Action=AssumeRoleWithWebIdentity&DurationSeconds=3600&WebIdentityToken=eyJ4NXQiOiJOVEF4Wm1NeE5ETXlaRGczTVRVMVpHTTBNekV6T0RKaFpXSTRORE5sWkRVMU9HRmtOakZpTVEiLCJraWQiOiJOVEF4Wm1NeE5ETXlaRGczTVRVMVpHTTBNekV6T0RKaFpXSTRORE5sWkRVMU9HRmtOakZpTVEiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiYXpwIjoiUG9FZ1hQNnVWTzQ1SXNFTlJuZ0RYajVBdTVZYSIsImlzcyI6Imh0dHBzOlwvXC9sb2NhbGhvc3Q6OTQ0M1wvb2F1dGgyXC90b2tlbiIsImV4cCI6MTU0MTgwOTU4MiwiaWF0IjoxNTQxODA1OTgyLCJqdGkiOiI2Y2YyMGIwZS1lNGZmLTQzZmQtYTdiYS1kYTc3YTE3YzM2MzYifQ.Jm29jPliRvrK6Os34nSK3rhzIYLFjE__zdVGNng3uGKXGKzP3We_i6NPnhA0szJXMOKglXzUF1UgSz8MctbaxFS8XDusQPVe4LkB_45hwBm6TmBxzui911nt-1RbBLN_jZIlvl2lPrbTUH5hSn9kEkph6seWanTNQpz9tNEoVa6R_OX3kpJqxe8tLQUWw453A1JTwFNhdHa6-f1K8_Q_eEZ_4gOYINQ9t_fhTibdbkXZkJQFLop-Jwoybi9s4nwQU_dATocgcufq5eCeNItQeleT-23lGxIz0X7CiJrJynYLdd-ER0F77SumqEb5iCxhxuf4H7dovwd1kAmyKzLxpw |
||||
``` |
||||
|
||||
#### Sample Response |
||||
``` |
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<AssumeRoleWithWebIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"> |
||||
<AssumeRoleWithWebIdentityResult> |
||||
<AssumedRoleUser> |
||||
<Arn/> |
||||
<AssumeRoleId/> |
||||
</AssumedRoleUser> |
||||
<Credentials> |
||||
<AccessKeyId>Y4RJU1RNFGK48LGO9I2S</AccessKeyId> |
||||
<SecretAccessKey>sYLRKS1Z7hSjluf6gEbb9066hnx315wHTiACPAjg</SecretAccessKey> |
||||
<Expiration>2018-11-09T16:51:11-08:00</Expiration> |
||||
<SessionToken>eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJZNFJKVTFSTkZHSzQ4TEdPOUkyUyIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTQxODExMDcxLCJpYXQiOjE1NDE4MDc0NzEsImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiYTBiMjc2MjktZWUxYS00M2JmLTg3MzktZjMzNzRhNGNkYmMwIn0.ewHqKVFTaP-j_kgZrcOEKroNUjk10GEp8bqQjxBbYVovV0nHO985VnRESFbcT6XMDDKHZiWqN2vi_ETX_u3Q-w</SessionToken> |
||||
</Credentials> |
||||
</AssumeRoleWithWebIdentityResult> |
||||
<ResponseMetadata/> |
||||
</AssumeRoleWithWebIdentityResponse> |
||||
``` |
||||
|
||||
#### Testing |
||||
``` |
||||
$ export MINIO_ACCESS_KEY=minio |
||||
$ export MINIO_SECRET_KEY=minio123 |
||||
$ export MINIO_IAM_JWKS_URL=https://www.googleapis.com/oauth2/v3/certs |
||||
$ minio server /mnt/export |
||||
|
||||
$ mc admin config get myminio |
||||
... |
||||
{ |
||||
"openid": { |
||||
"jwks": { |
||||
"url": "https://www.googleapis.com/oauth2/v3/certs" |
||||
} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
Testing with an example |
||||
> Visit [Google Developer Console](https://console.cloud.google.com) under Project, APIs, Credentials to get your OAuth2 client credentials. Add `http://localhost:8080/oauth2/callback` as a valid OAuth2 Redirect URL. |
||||
|
||||
``` |
||||
go run web-identity.go -cid 204367807228-ok7601k6gj1pgge7m09h7d79co8p35xx.apps.googleusercontent.com -csec XsT_PgPdT1nO9DD45rMLJw7G |
||||
2018/12/26 17:49:36 listening on http://localhost:8080/ |
||||
``` |
||||
|
||||
### Authorization Flow |
||||
|
||||
- Visit http://localhost:8080, login will direct the user to the Google OAuth2 Auth URL to obtain a permission grant. |
||||
- The redirection URI (callback handler) receives the OAuth2 callback, verifies the state parameter, and obtains a Token. |
||||
- Using the access token the callback handler further talks to Google OAuth2 Token URL to obtain an JWT id_token. |
||||
- Once obtained the JWT id_token is further sent to STS endpoint i.e Minio to retrive temporary credentials. |
||||
- Temporary credentials are displayed on the browser upon successful retrieval. |
||||
Loading…
Reference in new issue