# jenkinsci/credentials-plugin architecture

> Architecture diagram of the GitHub repository jenkinsci/credentials-plugin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jenkinsci/credentials-plugin
- Repository: https://github.com/jenkinsci/credentials-plugin

## Overview

##### Main Components

a. Core Components:
- Credentials Provider System
- Credentials Store
- Credentials Management UI
- CLI Interface
- Configuration as Code (CasC) Integration

b. Credential Types:
- Username/Password Credentials
- Certificate Credentials
- Custom Credential Types

**┌─ Jenkins Core Integration Layer ─────────────────────┐**
- Plugin Extension Points                           │
- Security Integration                              │
- ┘
- ↕
**┌─ Credentials Core Layer ──────────────────────────┐**
- ┌─ Credentials Provider Manager ─┐  ┌─ Stores ─┐  │
- System Credentials           │  │ - System  │  │
- User Credentials            │  │ - User    │  │
- Provider Filtering          │  │ - Domain  │  │
- ┘  └──────────┘  │
- ┘
- ↕
**┌─ Service Layer ────────────────────────────────────┐**
- ┌─ Core Services ─┐  ┌─ Security Services ───┐    │
- Matching      │  │ - Encryption          │    │
- Resolution    │  │ - Secret Management   │    │
- Validation    │  └────────────────────────┘    │
- ┘                                │
- ┘
- ↕
**┌─ Interface Layer ──────────────────────────────────┐**
- ┌─ UI ─────────┐  ┌─ CLI ─┐  ┌─ API ────────┐    │
- Management │  │ Commands│  │ - REST       │    │
- Selection  │  └────────┘  │ - Java API   │    │
- ┘              └─────────────┘    │
- ┘

##### Key Relationships

- Security boundary demarcations
- Integration points with Jenkins core
- User interaction flows

##### Important Implementation Details

- Domain model for credentials organization
- Extension points for custom credential types
- Configuration as code integration points
- Fingerprinting system for credential tracking

##### Additional Elements

- Notes about security boundaries
- Version compatibility information
- Integration points with other plugins

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#2196F3,color:white
    classDef security fill:#4CAF50,color:white
    classDef interface fill:#FFC107,color:black
    classDef external fill:#9E9E9E,color:white

    %% Jenkins Core Integration Layer
    subgraph JenkinsCore["Jenkins Core Integration Layer"]
        PluginExt["Plugin Extension Points"]
        SecInt["Security Integration"]
    end

    %% Credentials Core Layer
    subgraph CredCore["Credentials Core Layer"]
        ProviderMgr["Credentials Provider Manager"]:::core
        click ProviderMgr "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/CredentialsProviderManager.java"
        
        subgraph Providers["Providers"]
            SysProvider["System Provider"]:::core
            click SysProvider "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/SystemCredentialsProvider.java"
            UserProvider["User Provider"]:::core
            click UserProvider "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/UserCredentialsProvider.java"
        end
        
        subgraph Stores["Credential Stores"]
            CredStore["Credentials Store"]:::core
            click CredStore "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/CredentialsStore.java"
            Domain["Domain Model"]:::core
            click Domain "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/domains/Domain.java"
        end
    end

    %% Service Layer
    subgraph Services["Service Layer"]
        subgraph CoreServices["Core Services"]
            Matcher["Credential Matcher"]:::core
            click Matcher "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/CredentialsMatcher.java"
            Resolver["Credential Resolver"]:::core
            click Resolver "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/CredentialsResolver.java"
        end
        
        subgraph SecurityServices["Security Services"]
            ConfKey["Confidential Key"]:::security
            click ConfKey "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/CredentialsConfidentialKey.java"
            SecretMgmt["Secret Management"]:::security
            click SecretMgmt "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/SecretBytes.java"
        end
    end

    %% Interface Layer
    subgraph Interfaces["Interface Layer"]
        subgraph UI["User Interface"]
            StoreAction["Store Action"]:::interface
            click StoreAction "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/CredentialsStoreAction.java"
            ViewAction["View Action"]:::interface
            click ViewAction "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/ViewCredentialsAction.java"
            ManageConfig["Manage Configuration"]:::interface
            click ManageConfig "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/ManageCredentialsConfiguration.java"
        end
        
        subgraph CLI["CLI Interface"]
            CLICommands["CLI Commands"]:::interface
            click CLICommands "https://github.com/jenkinsci/credentials-plugin/tree/master/src/main/java/com/cloudbees/plugins/credentials/cli"
            BaseCLI["Base CLI Command"]:::interface
            click BaseCLI "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/cli/BaseCredentialsCLICommand.java"
        end
        
        subgraph CaSC["Configuration as Code"]
            CaSCConfig["CaSC Configurator"]:::interface
            click CaSCConfig "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/casc/CredentialsRootConfigurator.java"
        end
    end

    %% Credential Types
    subgraph CredTypes["Credential Types"]
        UserPass["Username/Password"]:::core
        click UserPass "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/impl/UsernamePasswordCredentialsImpl.java"
        Cert["Certificate"]:::core
        click Cert "https://github.com/jenkinsci/credentials-plugin/blob/master/src/main/java/com/cloudbees/plugins/credentials/impl/CertificateCredentialsImpl.java"
    end

    %% Relationships
    JenkinsCore --> CredCore
    CredCore --> Services
    Services --> Interfaces
    ProviderMgr --> Providers
    Providers --> Stores
    Stores --> Domain
    CoreServices --> SecurityServices
    UI --> CredStore
    CLI --> CredStore
    CaSC --> CredStore
    CredTypes --> CredStore

    %% Legend
    subgraph Legend
        CoreComp["Core Component"]:::core
        SecComp["Security Component"]:::security
        IntComp["Interface Component"]:::interface
        ExtComp["External Integration"]:::external
    end
```
