# securisec/cliam architecture

> Architecture diagram of the GitHub repository securisec/cliam, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/securisec/cliam
- Repository: https://github.com/securisec/cliam

## Overview

##### Project type and purpose
- This is a command-line application (“cliam”) for enumerating IAM permissions across multiple cloud providers (AWS, GCP, Azure). It is a monolithic Go-based CLI tool with a plugin-style internal structure for each provider.

##### File structure
- Top-level:
- cli/            – main binary (uses Cobra for commands/subcommands)
- aws/, gcp/, azure/ – provider-specific modules
– policy/      – policy definitions/generation
– scanner/     – code to query & parse permissions
– signer (AWS) – request signing
- shared/         – common helpers shared by all providers
- logger/         – centralized logging
- scripts/        – Python/Go scripts to generate or parse policy data
- .github/, goreleaser.yml – CI/CD, release automation
- Patterns:
- Command pattern via Cobra in cli/cmd
- Modular provider layers (divide each cloud into policy, scanner, signer)
- Shared utilities for concurrency, error handling, logging

##### README for additional insights
- Confirms three main commands: aws, gcp, azure (each with enumerate, service-group, rest, bruteforce modes)
- Emphasizes signed REST calls (AWS), REST or RPC calls (GCP), and Azure OAuth flows
- Mentions multi-threading, timeouts, and output formatting

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Entity
    User["User"]:::external

    %% CLI Layer
    subgraph "CLI Layer"
        Main["cli/main.go"]:::internal
        CmdRoot["cli/cmd/root.go"]:::internal
        CobraCmds["Cobra Commands (cli/cmd/*.go)"]:::internal
    end

    %% Shared Libraries
    subgraph "Shared Libraries"
        Helpers["shared/helpers.go"]:::shared
        Logger["logger/log.go"]:::shared
    end

    %% AWS Module
    subgraph "AWS Module"
        AWSModule["aws/aws.go"]:::internal
        AWSPolicy["Policy Generator (aws/policy)"]:::internal
        AWSSigner["Request Signer (aws/signer)"]:::internal
        AWSScanner["Scanner (aws/scanner/scan.go)"]:::internal
    end

    %% GCP Module
    subgraph "GCP Module"
        GCPModule["gcp/gcp.go"]:::internal
        GCPPolicy["Policy Definitions (gcp/policy)"]:::internal
        GCPREST["REST Client (gcp/rest)"]:::internal
        GCPScanner["Scanner (gcp/scanner)"]:::internal
    end

    %% Azure Module
    subgraph "Azure Module"
        AzureModule["azure/azure.go"]:::internal
        AzurePolicyLoader["Policy Loader (azure/policies.go)"]:::internal
        AzurePolicy["Policy Definitions (azure/policy)"]:::internal
        AzureScanner["Scanner (azure/scanner/main.go)"]:::internal
    end

    %% External Services
    subgraph "External Services"
        AWSAPI["AWS IAM REST API"]:::external
        GCPAPI["GCP IAM REST API"]:::external
        AzureAPI["Azure Resource Manager API"]:::external
    end

    %% Offline Scripts
    Scripts["Scripts (scripts/)"]:::offline

    %% CI/CD & Release
    subgraph "CI/CD & Release Automation"
        CI[".github/workflows"]:::ci
        Release[".goreleaser.yml"]:::ci
    end

    %% Connections
    User --> Main
    Main --> CmdRoot
    Main --> CobraCmds
    Main --> Helpers
    Main --> Logger

    Main --> AWSModule
    AWSModule --> AWSPolicy
    AWSPolicy --> AWSSigner
    AWSSigner --> AWSScanner
    AWSScanner --> AWSAPI
    AWSAPI --> AWSScanner
    AWSScanner --> Logger

    Main --> GCPModule
    GCPModule --> GCPPolicy
    GCPPolicy --> GCPREST
    GCPREST --> GCPScanner
    GCPScanner --> GCPAPI
    GCPAPI --> GCPScanner
    GCPScanner --> Logger

    Main --> AzureModule
    AzureModule --> AzurePolicyLoader
    AzurePolicyLoader --> AzurePolicy
    AzurePolicy --> AzureScanner
    AzureScanner --> AzureAPI
    AzureAPI --> AzureScanner
    AzureScanner --> Logger

    %% Offline and CI/CD
    Scripts:::offline
    CI:::ci
    Release:::ci

    %% Click Events
    click Main "https://github.com/securisec/cliam/blob/master/cli/main.go"
    click CmdRoot "https://github.com/securisec/cliam/blob/master/cli/cmd/root.go"
    click CobraCmds "https://github.com/securisec/cliam/tree/master/cli/cmd"
    click Helpers "https://github.com/securisec/cliam/blob/master/shared/helpers.go"
    click Logger "https://github.com/securisec/cliam/blob/master/logger/log.go"
    click AWSModule "https://github.com/securisec/cliam/blob/master/aws/aws.go"
    click AWSPolicy "https://github.com/securisec/cliam/tree/master/aws/policy"
    click AWSSigner "https://github.com/securisec/cliam/tree/master/aws/signer"
    click AWSScanner "https://github.com/securisec/cliam/blob/master/aws/scanner/scan.go"
    click GCPModule "https://github.com/securisec/cliam/blob/master/gcp/gcp.go"
    click GCPPolicy "https://github.com/securisec/cliam/tree/master/gcp/policy"
    click GCPREST "https://github.com/securisec/cliam/tree/master/gcp/rest"
    click GCPScanner "https://github.com/securisec/cliam/tree/master/gcp/scanner"
    click AzureModule "https://github.com/securisec/cliam/blob/master/azure/azure.go"
    click AzurePolicyLoader "https://github.com/securisec/cliam/blob/master/azure/policies.go"
    click AzurePolicy "https://github.com/securisec/cliam/tree/master/azure/policy"
    click AzureScanner "https://github.com/securisec/cliam/blob/master/azure/scanner/main.go"
    click Scripts "https://github.com/securisec/cliam/tree/master/scripts"
    click CI "https://github.com/securisec/cliam/tree/master/.github/workflows"
    click Release "https://github.com/securisec/cliam/blob/master/.goreleaser.yml"

    %% Styles
    classDef internal fill:#AED6F1,stroke:#21618C,color:#1B2631
    classDef shared fill:#ABEBC6,stroke:#196F3D,color:#1B2631
    classDef external fill:#F5B7B1,stroke:#922B21,color:#1B2631
    classDef offline fill:#D5D8DC,stroke:#566573,color:#1B2631
    classDef ci fill:#E8DAEF,stroke:#6C3483,color:#1B2631
```
