Extension Points defined in Credentials Plugin

Table of Contents

Credentials
CredentialsProvider
CredentialsProviderFilter
CredentialsProviderTypeRestriction
CredentialsSelectHelper.ContextResolver
CredentialsSnapshotTaker
CredentialsTypeFilter
CredentialsUseListener
DomainRequirement
DomainSpecification

Credentials

com.cloudbees.plugins.credentials.Credentials in credentials

A generic type of credentials. In general please extend from BaseCredentials rather than implement this interface. The interface is provided:

To allow for orthogonal traits to be built up in interfaces that extend credentials, e.g. username/password vs username/ssh-key vs email/password - a single credentials impl could provide all four fields and different credentials consumers might request the different flavours
In order to facility cases where it is just not possible to change the base class when retrofitting support for credentials into an existing plugin.

Implementations:

Azure Cosmos DB Plugin: io.jenkins.plugins.azurecosmosdb.AzureCosmosDBCredentials (view on GitHub)
Azure Cosmos DB Plugin: io.jenkins.plugins.azurecosmosdb.AzureCosmosDBCredentialsImpl (view on GitHub)
Azure Cosmos DB Plugin: io.jenkins.plugins.azurecosmosdb.AzureCosmosDBKeyCredentials (view on GitHub)
Azure Cosmos DB Plugin: io.jenkins.plugins.azurecosmosdb.AzureCosmosDBKeyCredentialsImpl (view on GitHub)
Azure Credentials Ext Plugin: com.mastercard.labs.keyvault.SecretPersonalAccessTokenCredentials (view on GitHub)
Azure Credentials Ext Plugin: com.mastercard.labs.keyvault.SecretSSHUserPrivateKeyCredentials (view on GitHub)
Azure Credentials Ext Plugin: com.mastercard.labs.keyvault.SecretUsernamePasswordCredentials (view on GitHub)
Azure Key Vault Plugin: org.jenkinsci.plugins.azurekeyvaultplugin.credentials.string.AzureSecretStringCredentials (view on GitHub)
Azure Key Vault Plugin: org.jenkinsci.plugins.azurekeyvaultplugin.credentials.usernamepassword.AzureUsernamePasswordCredentials (view on GitHub)
BrowserStack Plugin: com.browserstack.automate.ci.jenkins.BrowserStackCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.BaseCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.impl.BaseStandardCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.CertificateCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.impl.CertificateCredentialsImpl (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.DomainRestrictedCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.IdCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.PasswordCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.StandardCertificateCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.StandardCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.StandardUsernameCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.UsernameCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.common.UsernamePasswordCredentials (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl (view on GitHub)
Fortify Plugin: com.fortify.plugin.jenkins.credentials.FortifyApiToken (view on GitHub)
Fortify Plugin: com.fortify.plugin.jenkins.credentials.StandardFortifyApiToken (view on GitHub)
GCP Secrets Manager Credentials Provider Plugin: io.jenkins.plugins.credentials.gcp.secretsmanager.GcpCertificateCredentials (view on GitHub)
GCP Secrets Manager Credentials Provider Plugin: io.jenkins.plugins.credentials.gcp.secretsmanager.GcpFileCredentials (view on GitHub)
GCP Secrets Manager Credentials Provider Plugin: io.jenkins.plugins.credentials.gcp.secretsmanager.GcpSshUserPrivateKey (view on GitHub)
GCP Secrets Manager Credentials Provider Plugin: io.jenkins.plugins.credentials.gcp.secretsmanager.GcpStringCredentials (view on GitHub)
GCP Secrets Manager Credentials Provider Plugin: io.jenkins.plugins.credentials.gcp.secretsmanager.GcpUsernamePasswordCredentials (view on GitHub)
Gitee Plugin: com.gitee.jenkins.connection.GiteeApiToken (view on GitHub)
Gitee Plugin: com.gitee.jenkins.connection.GiteeApiTokenImpl (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials.DelegatingGitHubAppCredentials (view on GitHub)
Google Authenticated Source Plugin: com.google.jenkins.plugins.source.GoogleRobotUsernamePassword (view on GitHub)
Google Container Registry Auth Plugin: com.google.jenkins.plugins.googlecontainerregistryauth.GoogleContainerRegistryCredential (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.GoogleOAuth2Credentials (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.GoogleRobotMetadataCredentials (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.GoogleRobotPrivateKeyCredentials (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.RemotableGoogleCredentials (view on GitHub)
HeadSpin Plugin: io.jenkins.plugins.headspin.HeadSpinCredentials (view on GitHub)
JClouds Plugin: jenkins.plugins.jclouds.credentials.JCloudsUserWithKey (view on GitHub)
JClouds Plugin: jenkins.plugins.jclouds.credentials.OpenstackKeystoneV3 (view on GitHub)
Kubernetes Credentials Plugin: org.jenkinsci.plugins.kubernetes.credentials.FileSystemServiceAccountCredential (view on GitHub)
Kubernetes Credentials Plugin: org.jenkinsci.plugins.kubernetes.credentials.OpenShiftBearerTokenCredentialImpl (view on GitHub)
Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.OpenShiftBearerTokenCredentialImpl (view on GitHub)
Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.OpenShiftTokenCredentialImpl (view on GitHub)
Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.ServiceAccountCredential (view on GitHub)
Load Impact Plugin: com.loadimpact.jenkins_plugin.ApiTokenCredentials (view on GitHub)
OctoPerf Load Testing Plugin: org.jenkinsci.plugins.octoperf.OctoperfCredential (view on GitHub)
OctoPerf Load Testing Plugin: org.jenkinsci.plugins.octoperf.OctoperfCredentialImpl (view on GitHub)
OpenID Connect Provider Plugin: io.jenkins.plugins.oidc_provider.IdTokenCredentials (view on GitHub)
OpenID Connect Provider Plugin: io.jenkins.plugins.oidc_provider.IdTokenFileCredentials (view on GitHub)
OpenID Connect Provider Plugin: io.jenkins.plugins.oidc_provider.IdTokenStringCredentials (view on GitHub)
OpenStack Cloud Plugin: jenkins.plugins.openstack.compute.auth.AbstractOpenstackCredential (view on GitHub)
OpenStack Cloud Plugin: jenkins.plugins.openstack.compute.auth.OpenstackCredential (view on GitHub)
OpenStack Cloud Plugin: jenkins.plugins.openstack.compute.auth.OpenstackCredentialv2 (view on GitHub)
OpenStack Cloud Plugin: jenkins.plugins.openstack.compute.auth.OpenstackCredentialv3 (view on GitHub)
Oracle Cloud Infrastructure Compute Plugin: com.oracle.cloud.baremetal.jenkins.credentials.BaremetalCloudCredentials (view on GitHub)
Oracle Cloud Infrastructure Compute Plugin: com.oracle.cloud.baremetal.jenkins.credentials.BaremetalCloudCredentialsImpl (view on GitHub)
Oracle Cloud Infrastructure DevOps Plugin: io.jenkins.plugins.oci.credentials.CloudCredentials (view on GitHub)
Oracle Cloud Infrastructure DevOps Plugin: io.jenkins.plugins.oci.credentials.CloudCredentialsImpl (view on GitHub)
Sauce OnDemand Plugin: hudson.plugins.sauce_ondemand.credentials.SauceCredentials (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.impl.BaseSSHUser (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPassword (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.SSHUser (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.SSHUserPassword (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.SSHUserPrivateKey (view on GitHub)
TestingBot Plugin: testingbot.TestingBotCredentials (view on GitHub)
Zoho Sprints Plugin: io.jenkins.plugins.configuration.SprintsApiToken (view on GitHub)
Zoho Sprints Plugin: io.jenkins.plugins.configuration.SprintsApiTokenImpl (view on GitHub)

CredentialsProvider

com.cloudbees.plugins.credentials.CredentialsProvider in credentials

An extension point for providing Credentials .

Implementations:

Azure Key Vault Plugin: org.jenkinsci.plugins.azurekeyvaultplugin.AzureCredentialsProvider (view on GitHub)
Credentials Plugin: Anonymous class in com.cloudbees.plugins.credentials.CredentialsProvider (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.SystemCredentialsProvider.ProviderImpl (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.UserCredentialsProvider (view on GitHub)
Folders Plugin: com.cloudbees.hudson.plugins.folder.properties.FolderCredentialsProvider (view on GitHub)
GCP Secrets Manager Credentials Provider Plugin: io.jenkins.plugins.credentials.gcp.secretsmanager.GcpCredentialsProvider (view on GitHub)
Google Authenticated Source Plugin: com.google.jenkins.plugins.source.GoogleRobotUsernamePasswordProvider (view on GitHub)
Google Container Registry Auth Plugin: com.google.jenkins.plugins.googlecontainerregistryauth.GoogleContainerRegistryCredentialProvider (view on GitHub)

CredentialsProviderFilter

com.cloudbees.plugins.credentials.CredentialsProviderFilter in credentials

A filter of CredentialsProvider instances used by CredentialsProviderManager to determine which providers are active.

Implementations:

Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsProviderFilter.Excludes (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsProviderFilter.Includes (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsProviderFilter.None (view on GitHub)

CredentialsProviderTypeRestriction

com.cloudbees.plugins.credentials.CredentialsProviderTypeRestriction in credentials

A filter of CredentialsDescriptor types scoped to specific CredentialsProvider instances used by CredentialsProviderManager to determine which types are applicable to each provider.

Implementations:

Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsProviderTypeRestriction.Excludes (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsProviderTypeRestriction.Includes (view on GitHub)

CredentialsSelectHelper.ContextResolver

com.cloudbees.plugins.credentials.CredentialsSelectHelper.ContextResolver in credentials

An extension point to allow plugging in additional resolution of ModelObject instances.

Implementations:

Credentials Plugin: Anonymous class in com.cloudbees.plugins.credentials.CredentialsSelectHelper (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsSelectHelper.ItemContextResolver (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsSelectHelper.SystemContextResolver (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsSelectHelper.UserContextResolver (view on GitHub)

CredentialsSnapshotTaker

com.cloudbees.plugins.credentials.CredentialsSnapshotTaker in credentials

Some credential types can store some of the credential details in a file outside of Jenkins. Taking a snapshot of the credential ensures that all the details are captured within the credential. For example com.cloudbees.plugins.credentials.impl.CertificateCredentialsImpl can use different keystores implementations to hold the certificate. Calling #snapshot(Credentials) resolve the actual source into a source like com.cloudbees.plugins.credentials.impl.CertificateCredentialsImpl.UploadedKeyStoreSource which is self contained.

Implementations:

Azure Key Vault Plugin: org.jenkinsci.plugins.azurekeyvaultplugin.credentials.string.AzureSecretStringCredentialsSnapshotTaker (view on GitHub)
Azure Key Vault Plugin: org.jenkinsci.plugins.azurekeyvaultplugin.credentials.usernamepassword.AzureUsernamePasswordCredentialsSnapshotTaker (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsSnapshotTaker (view on GitHub)
GitHub Branch Source Plugin: org.jenkinsci.plugins.github_branch_source.GitHubAppCredentialsSnapshotTaker (view on GitHub)
SSH Credentials Plugin: com.cloudbees.jenkins.plugins.sshcredentials.impl.SSHUserPrivateKeySnapshotTaker (view on GitHub)

CredentialsTypeFilter

com.cloudbees.plugins.credentials.CredentialsTypeFilter in credentials

A filter of CredentialsDescriptor types used by CredentialsProviderManager to determine which types are active.

Implementations:

Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsTypeFilter.Excludes (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsTypeFilter.Includes (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.CredentialsTypeFilter.None (view on GitHub)

CredentialsUseListener

com.cloudbees.plugins.credentials.CredentialsUseListener in credentials

A Listener to track Credentials usage.

Implementations:

Audit Trail Plugin: hudson.plugins.audit_trail.CredentialUsageListener (view on GitHub)

DomainRequirement

com.cloudbees.plugins.credentials.domains.DomainRequirement in credentials

Base class for all requirements that can be fulfilled by Domain s.

Implementations:

Config File Provider Plugin: org.jenkinsci.plugins.configfiles.maven.security.MavenServerIdRequirement (view on GitHub)
Config File Provider Plugin: org.jenkinsci.plugins.configfiles.properties.security.PropertyKeyRequirement (view on GitHub)
Config File Provider Plugin: org.jenkinsci.plugins.configfiles.custom.security.TokenKeyRequirement (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.HostnamePortRequirement (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.HostnameRequirement (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.PathRequirement (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.SchemeRequirement (view on GitHub)
GCloud SDK Plugin: com.byclosure.jenkins.plugins.gcloud.GCloudScopeRequirement (view on GitHub)
Google Authenticated Source Plugin: com.google.jenkins.plugins.source.CloudPlatformSourceScopeRequirement (view on GitHub)
Google Authenticated Source Plugin: com.google.jenkins.plugins.source.GerritSourceScopeRequirement (view on GitHub)
Google Cloud Storage Plugin: com.google.jenkins.plugins.storage.StorageScopeRequirement (view on GitHub)
Google Compute Engine Plugin: com.google.jenkins.plugins.computeengine.ComputeEngineScopeRequirement (view on GitHub)
Google Container Registry Auth Plugin: com.google.jenkins.plugins.googlecontainerregistryauth.GoogleContainerRegistryScopeRequirement (view on GitHub)
Google Deployment Manager Plugin: com.google.jenkins.plugins.manage.CloudDeploymentDeleter.ScopeRequirement (view on GitHub)
Google Deployment Manager Plugin: com.google.jenkins.plugins.manage.TemplatedCloudDeployment.ScopeRequirement (view on GitHub)
Google Kubernetes Engine Plugin: com.google.jenkins.plugins.k8sengine.client.ContainerScopeRequirement (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.GoogleOAuth2ScopeRequirement (view on GitHub)
Kubernetes Credentials Plugin: Anonymous class in org.jenkinsci.plugins.kubernetes.tokensource.GoogleRobotCredentialsTokenSource (view on GitHub)

DomainSpecification

com.cloudbees.plugins.credentials.domains.DomainSpecification in credentials

Base class for a specification against which DomainRequirement s can be tested.

Implementations:

Config File Provider Plugin: org.jenkinsci.plugins.configfiles.maven.security.MavenServerIdSpecification (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.HostnamePortSpecification (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.HostnameSpecification (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.PathSpecification (view on GitHub)
Credentials Plugin: com.cloudbees.plugins.credentials.domains.SchemeSpecification (view on GitHub)
Google OAuth Credentials Plugin: com.google.jenkins.plugins.credentials.oauth.GoogleOAuth2ScopeSpecification (view on GitHub)

Extension Points defined in Credentials Plugin

Credentials

CredentialsProvider

CredentialsProviderFilter

CredentialsProviderTypeRestriction

CredentialsSelectHelper.ContextResolver

CredentialsSnapshotTaker

CredentialsTypeFilter

CredentialsUseListener

DomainRequirement

DomainSpecification

Resources

Project

Community

Other