-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Storage identity remove resource manager provider #15837
Changes from 1 commit
03f8ab4
7266ac5
0de9b40
3964b68
9fb49ba
9acd2b9
bedcf50
9ad8a79
f9adbe0
9cac0d3
c2bbb46
41f32fa
8c1297b
f0322af
8a6385c
9305ee1
92fd3dd
06d8aa9
723e463
62c5533
b96c739
3f7e8ac
670e4a2
cfef365
f7f9414
9662b85
6f780a9
ef3f807
525c5b4
7d7adb1
80a9e20
9277d71
e4608d5
42d5e50
29beabc
969353e
bbc811e
01b1378
cc74b40
cdb5ed4
bccd6e2
9a206f1
f19af87
7bec935
456d383
9b1792b
fcb8bc8
a6cfcfe
8277c89
005e67f
552af0c
2456b26
8558375
dde0594
2a7d5a3
5531c84
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,8 @@ | |
import org.springframework.core.env.Environment; | ||
|
||
import com.azure.core.credential.TokenCredential; | ||
import com.azure.identity.ChainedTokenCredential; | ||
import com.azure.identity.ChainedTokenCredentialBuilder; | ||
import com.azure.identity.ClientCertificateCredentialBuilder; | ||
import com.azure.identity.ClientSecretCredentialBuilder; | ||
import com.azure.identity.DefaultAzureCredentialBuilder; | ||
|
@@ -54,121 +56,143 @@ | |
*/ | ||
public class SpringEnvironmentTokenBuilder { | ||
|
||
/** | ||
* Defines the AZURE_CREDENTIAL_PREFIX. | ||
*/ | ||
private static final String AZURE_CREDENTIAL_PREFIX = "azure.credential."; | ||
|
||
/** | ||
* Stores the named credentials. | ||
*/ | ||
private final HashMap<String, TokenCredential> credentials; | ||
|
||
/** | ||
* Stores the name of the credential to be returned. If omitted, the default | ||
* credential will be returned. | ||
*/ | ||
private String name = ""; | ||
|
||
/** | ||
* Constructor. | ||
*/ | ||
public SpringEnvironmentTokenBuilder() { | ||
credentials = new HashMap<>(); | ||
credentials.put("", new DefaultAzureCredentialBuilder().build()); | ||
} | ||
|
||
/** | ||
* Populate from Environment. | ||
* | ||
* @param environment the environment. | ||
*/ | ||
public SpringEnvironmentTokenBuilder fromEnvironment(Environment environment) { | ||
populateNamedCredential(environment, ""); | ||
String credentialNamesKey = AZURE_CREDENTIAL_PREFIX + "names"; | ||
if (environment.containsProperty(credentialNamesKey)) { | ||
String[] credentialNames = environment.getProperty(credentialNamesKey).split(","); | ||
for (int i = 0; i < credentialNames.length; i++) { | ||
populateNamedCredential(environment, credentialNames[i]); | ||
} | ||
} | ||
return this; | ||
} | ||
|
||
/** | ||
* Populate a named credential. | ||
* | ||
* @param environment the environment | ||
* @param name the name. | ||
*/ | ||
private void populateNamedCredential(Environment environment, String name) { | ||
String standardizedName = name; | ||
|
||
if (!standardizedName.equals("") && !standardizedName.endsWith(".")) { | ||
standardizedName = standardizedName + "."; | ||
} | ||
|
||
String tenantIdKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "tenantId"; | ||
String clientIdKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "clientId"; | ||
String clientSecretKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "clientSecret"; | ||
|
||
String tenantId = environment.getProperty(tenantIdKey); | ||
String clientId = environment.getProperty(clientIdKey); | ||
String clientSecret = environment.getProperty(clientSecretKey); | ||
|
||
if (tenantId != null && clientId != null && clientSecret != null) { | ||
TokenCredential credential = new ClientSecretCredentialBuilder().tenantId(tenantId).clientId(clientId) | ||
.clientSecret(clientSecret).build(); | ||
credentials.put(name, credential); | ||
return; | ||
} | ||
|
||
String clientCertificateKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "clientCertificate"; | ||
String clientCertificatePath = environment.getProperty(clientCertificateKey); | ||
|
||
if (tenantId != null && clientId != null && clientCertificatePath != null) { | ||
TokenCredential credential = new ClientCertificateCredentialBuilder().tenantId(tenantId).clientId(clientId) | ||
.pemCertificate(clientCertificatePath).build(); | ||
credentials.put(name, credential); | ||
return; | ||
} | ||
|
||
if (!name.equals("")) { | ||
throw new IllegalStateException("Configuration for azure.credential." + name + " is incomplete"); | ||
} | ||
} | ||
|
||
/** | ||
* Sets the builder to return a credential named <code>name</code> | ||
* | ||
* @param name | ||
* @return | ||
*/ | ||
public SpringEnvironmentTokenBuilder namedCredential(String name) { | ||
this.name = name; | ||
return this; | ||
} | ||
|
||
/** | ||
* Sets the builder to return the default credential. | ||
*/ | ||
public SpringEnvironmentTokenBuilder defaultCredential() { | ||
return namedCredential(""); | ||
} | ||
|
||
/** | ||
* Builds an Azure TokenCredendial. | ||
* | ||
* @throws IllegalArgumentException if attempting to retrieve a named credential | ||
* not defined in the environment. | ||
*/ | ||
public TokenCredential build() { | ||
TokenCredential result = credentials.get(name); | ||
if (result == null) { | ||
throw new IllegalArgumentException( | ||
"Attempting to retrieve Azure credential not configured in the environment. (name=" + name + ")"); | ||
} else { | ||
return result; | ||
} | ||
} | ||
/** | ||
* Defines the AZURE_CREDENTIAL_PREFIX. | ||
*/ | ||
private static final String AZURE_CREDENTIAL_PREFIX = "azure.credential."; | ||
|
||
/** | ||
* Stores the named credentials. | ||
*/ | ||
private final HashMap<String, TokenCredential> credentials; | ||
|
||
/** | ||
* Stores the name of the credential to be returned. If omitted, the default | ||
* credential will be returned. | ||
*/ | ||
private String name = ""; | ||
|
||
/** | ||
* Constructor. | ||
*/ | ||
public SpringEnvironmentTokenBuilder() { | ||
credentials = new HashMap<>(); | ||
credentials.put("", new DefaultAzureCredentialBuilder().build()); | ||
} | ||
|
||
/** | ||
* Populate from Environment. | ||
* | ||
* @param environment the environment. | ||
*/ | ||
public SpringEnvironmentTokenBuilder fromEnvironment(Environment environment) { | ||
populateNamedCredential(environment, ""); | ||
String credentialNamesKey = AZURE_CREDENTIAL_PREFIX + "names"; | ||
if (environment.containsProperty(credentialNamesKey)) { | ||
String[] credentialNames = environment.getProperty(credentialNamesKey).split(","); | ||
for (int i = 0; i < credentialNames.length; i++) { | ||
populateNamedCredential(environment, credentialNames[i]); | ||
} | ||
} | ||
return this; | ||
} | ||
|
||
/** | ||
* Sets a credential to override a named credential. If this credential fails to produce a token, | ||
* the original token credential will be used. | ||
* | ||
* @param name | ||
* @param credential | ||
* @return | ||
*/ | ||
public SpringEnvironmentTokenBuilder overrideNamedCredential(String name, TokenCredential credential) { | ||
TokenCredential currentCredential = credentials.get(name); | ||
if (currentCredential == null) { | ||
credentials.put(name, credential); | ||
} else { | ||
ChainedTokenCredentialBuilder builder = new ChainedTokenCredentialBuilder(); | ||
builder.addFirst(credential); | ||
builder.addLast(currentCredential); | ||
credentials.put(name, builder.build()); | ||
} | ||
|
||
return this; | ||
} | ||
|
||
/** | ||
* Populate a named credential. | ||
* | ||
* @param environment the environment | ||
* @param name the name. | ||
*/ | ||
private void populateNamedCredential(Environment environment, String name) { | ||
String standardizedName = name; | ||
|
||
if (!standardizedName.equals("") && !standardizedName.endsWith(".")) { | ||
standardizedName = standardizedName + "."; | ||
} | ||
|
||
String tenantIdKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "tenantId"; | ||
String clientIdKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "clientId"; | ||
String clientSecretKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "clientSecret"; | ||
|
||
String tenantId = environment.getProperty(tenantIdKey); | ||
String clientId = environment.getProperty(clientIdKey); | ||
String clientSecret = environment.getProperty(clientSecretKey); | ||
|
||
if (tenantId != null && clientId != null && clientSecret != null) { | ||
TokenCredential credential = new ClientSecretCredentialBuilder().tenantId(tenantId).clientId(clientId) | ||
.clientSecret(clientSecret).build(); | ||
credentials.put(name, credential); | ||
return; | ||
} | ||
|
||
String clientCertificateKey = AZURE_CREDENTIAL_PREFIX + standardizedName + "clientCertificate"; | ||
String clientCertificatePath = environment.getProperty(clientCertificateKey); | ||
|
||
if (tenantId != null && clientId != null && clientCertificatePath != null) { | ||
TokenCredential credential = new ClientCertificateCredentialBuilder().tenantId(tenantId).clientId(clientId) | ||
.pemCertificate(clientCertificatePath).build(); | ||
credentials.put(name, credential); | ||
return; | ||
} | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For system assigned identity, tenant id is needed. Code here has some problems work with system assigned identity and user assigned identity. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would it be simpler to always fall back to DefaultAzureCredentialBuilder? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I defer to @mnriem on this. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For system assigned you do not need tenant id. User-assigned was not targeted and would need to be added if required. |
||
if (!name.equals("")) { | ||
throw new IllegalStateException("Configuration for azure.credential." + name + " is incomplete"); | ||
} | ||
} | ||
|
||
/** | ||
* Sets the builder to return a credential named <code>name</code> | ||
* | ||
* @param name | ||
* @return | ||
*/ | ||
public SpringEnvironmentTokenBuilder namedCredential(String name) { | ||
this.name = name; | ||
return this; | ||
} | ||
|
||
/** | ||
* Sets the builder to return the default credential. | ||
*/ | ||
public SpringEnvironmentTokenBuilder defaultCredential() { | ||
return namedCredential(""); | ||
} | ||
|
||
/** | ||
* Builds an Azure TokenCredendial. | ||
* | ||
* @throws IllegalArgumentException if attempting to retrieve a named credential | ||
* not defined in the environment. | ||
*/ | ||
public TokenCredential build() { | ||
TokenCredential result = credentials.get(name); | ||
if (result == null) { | ||
throw new IllegalArgumentException( | ||
"Attempting to retrieve Azure credential not configured in the environment. (name=" + name + ")"); | ||
} else { | ||
return result; | ||
} | ||
} | ||
} |
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.
Is it possible to consider make use of @ConfigurationProperties and model different credentials as Map, so that we don't need the 'names' here.
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 is a repackaging of @mnriem's code, so perhaps he can answer better. My understanding is that a custom map is needed because property values could come from multiple sources, and this serves to consolidate them in a single place.
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.
The 'names' defines the order of the chain.