Configuring OpenID Connect for Infisical
This document outlines the steps required to configure Pulumi to use OpenID Connect to authenticate with Infisical. OIDC in Infisical uses identities to access Infisical resources. Access to the temporary credentials is authorized using identities that validate the contents of the OIDC token issued by the Pulumi Cloud.
Prerequisites
- You must be an admin of your Infisical organization to create and configure identities.
Creating an Identity
In the navigation pane of the Infisical app:
- Select Admin, Access Control, Identities and then click Create Identity.
- Provide a name for your application (ex:
pulumi-esc-oidc-app
). - Select a Role for the identity.
- Click Create.
After the Identity has been created, take note of the following details:
- Identity ID
This value will be necessary when enabling OIDC for your service.
Add OIDC Authentication
Once you have created your new identity, you will be redirected to the identity’s Overview page. In the Authentication section:
- Remove the existing Universal Auth configuration.
- Click on the Add Auth Method button. This will start an “Add Auth Method” wizard.
- In the wizard, select OIDC Auth as the Auth Method.
- Fill in the remaining form fields as follows:
- OIDC Discovery URL:
https://api.pulumi.com/oidc
- Issuer:
https://api.pulumi.com/oidc
- Subject: This can be left empty. If it’s empty, all ESC Environments of your organization would be able to assume this identity. We recommend configuring the subject claim for finer permission. (see examples at the end of this section).
- Audiences: This is different between Pulumi deployments and ESC. For Deployments this is only the name of your Pulumi organization. For ESC this is the name of your Pulumi organization prefixed with
infisical:
(e.g.infisical:{org}
).For environments in thedefault
project the audience will use just the Pulumi organization name. This is to prevent regressions for legacy environments.
- OIDC Discovery URL:
Configure ESC for OIDC
To configure OIDC for Pulumi ESC, create a new environment in the Pulumi Console. Make sure that you have the correct organization selected in the left-hand navigation menu. Then:
Click the Environments link.
Click the Create environment button.
Provide a project to create your new environment in and a name for your environment.
- This should be the same as the identifier provided in the subject claim of your federated credentials.
Click the Create environment button.
You will be presented with a split-pane view. Delete the default placeholder content in the editor and replace it with the following code:
values: infisical: login: fn::open::infisical-login: oidc: identityId: <your-identity-id> environmentVariables: INFISICAL_TOKEN: ${infisical.login.accessToken}
Replace
<your-identity-id>
with the value from the previous steps.Scroll to the bottom of the page and click Save.
You can validate that your configuration is working by running either of the following:
esc open <your-org>/<your-project>/<your-environment>
command of the ESC CLIpulumi env open <your-org>/<your-project>/<your-environment>
command of the Pulumi CLI
Make sure to replace <your-org>
, <your-project>
, and <your-environment>
with the values of your Pulumi
organization, project, and environment file respectively. You should see output similar to the following:
{
"infisical": {
"login": {
"accessToken": "eyJh...."
}
},
"environmentVariables": {
"INFISICAL_TOKEN": "eyJh...."
}
}
To learn more about how to set up and use the various providers in Pulumi ESC, please refer to the relevant Pulumi documentation
Subject claim customization
You can customize the subject claim in the OIDC token to control which Pulumi environments or users are allowed to assume a given identity. This allows for more granular access control than the default organization-level permissions.
This is done by configuring the subjectAttributes
setting. It expects an array of keys to include in it:
rootEnvironment.name
: the name of the environment that is opened first. This root environment in turn opens other imported environmentscurrentEnvironment.name
: the full name (including the project) of the environment where the ESC login provider andsubjectAttributes
are definedpulumi.user.login
: the login identifier of the user opening the environmentpulumi.organization.login
: the login identifier of the organization
The subject always contains the following prefix pulumi:environments:pulumi.organization.login:{ORGANIZATION_NAME}
and
every key configured will be appended to this prefix. For example, consider the following environment:
values:
infisical:
login:
fn::open::infisical-login:
oidc:
identityId: <your-identity-id>
subjectAttributes:
- currentEnvironment.name
- pulumi.user.login
The subject will be
pulumi:environments:pulumi.organization.login:contoso:currentEnvironment.name:project/development:pulumi.user.login:userLogin
.
Note how the keys and values are appended along with the prefix.
If not customized, the subject claim has the following format by default:
pulumi:environments:org:<organization name>:env:<project name>/<environment name>
default
project, the project will not be present in the subject to preserve
backwards compatibility. The format of the subject claim when subjectAttributes
are not set is
pulumi:environments:org:<organization name>:env:<environment name>
. If currentEnvironment.name
is used as a custom
subject attribute it will resolve to only the environment name (e.g.
pulumi:environments:pulumi.organization.login:contoso:currentEnvironment.name:development:pulumi.user.login:personA
).
Due to this it is recommended to move your environments out of the default
project for best security practices.Subject claim example
Here is an example of a valid, not customized subject claim for the project/development
environment of the contoso
organization:
pulumi:environments:org:contoso:env:project/development
If you are integrating Pulumi ESC with Pulumi IaC, the default subject identifier of the ESC environment will not work at this time. There is a known issue with the subject identifier’s value sent to Infisical from Pulumi.
Use ‘subjectAttributes’ to customize the subject identifier to work with Pulumi IaC. Alternatively, you can use this
syntax: pulumi:environments:org:contoso:env:<yaml>
when configuring the subject claim in your cloud provider account.
Make sure to replace contoso
with the name of your Pulumi organization and use the literal value of <yaml>
as shown.
Thank you for your feedback!
If you have a question about how to use Pulumi, reach out in Community Slack.
Open an issue on GitHub to report a problem or suggest an improvement.