{"id":28063714,"url":"https://github.com/outscale/uar","last_synced_at":"2025-06-15T19:38:43.819Z","repository":{"id":291108219,"uuid":"970616017","full_name":"outscale/UAR","owner":"outscale","description":"User Access-rights Review","archived":false,"fork":false,"pushed_at":"2025-05-02T12:30:51.000Z","size":153,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-12T12:18:45.663Z","etag":null,"topics":["maturity-sandbox"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-22T09:24:44.000Z","updated_at":"2025-05-02T12:29:34.000Z","dependencies_parsed_at":"2025-05-02T13:47:26.516Z","dependency_job_id":"c1945016-e252-4cc2-b9ad-4963b47dc723","html_url":"https://github.com/outscale/UAR","commit_stats":null,"previous_names":["outscale/uar"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2FUAR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2FUAR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2FUAR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2FUAR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/UAR/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253736105,"owners_count":21955786,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maturity-sandbox"],"created_at":"2025-05-12T12:18:55.558Z","updated_at":"2025-05-12T12:18:56.112Z","avatar_url":"https://github.com/outscale.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UAR (User Access-Rights Review)\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"UAR\" src=\"./uar-logo-512x512.png\" width=\"128px\"\u003e\n\u003c/p\u003e\n\n---\n\n## 🌐 Links\n\n- OUTSCALE API documentation: https://docs.outscale.com/en/\n- UAR GitHub repository: https://github.com/outscale/uar\n\n---\n\n## 📄 Table of Contents\n\n- [UAR (User Access-Rights Review)](#uar-user-access-rights-review)\n  - [🌐 Links](#-links)\n  - [📄 Table of Contents](#-table-of-contents)\n  - [🧭 Overview](#-overview)\n  - [✅ Requirements](#-requirements)\n  - [⚙️ Install](#️-install)\n    - [from source](#from-source)\n      - [1. Install Rust](#1-install-rust)\n      - [2. Clone the repository](#2-clone-the-repository)\n      - [3. Update dependencies](#3-update-dependencies)\n      - [4. Build the project](#4-build-the-project)\n      - [5. Install locally](#5-install-locally)\n    - [from pre-compiled binaries](#from-pre-compiled-binaries)\n  - [🚀 Usage](#-usage)\n    - [Basic command](#basic-command)\n    - [Optional filters](#optional-filters)\n  - [📦 Report Output](#-report-output)\n  - [🔐 Authorization Review](#-authorization-review)\n    - [Access Control Rules to Remember](#access-control-rules-to-remember)\n  - [🤝 Contributing](#-contributing)\n\n---\n\n## 🧭 Overview\n\n**UAR** (User Access-Rights Review) is a command-line tool that provides an access rights assessment for users and resources in an OUTSCALE account.\n\nIt performs read operations using the OUTSCALE API (oAPI) to:\n- Build an inventory of all resources\n- Evaluate access policies for each user, including group-based permissions\n- Output a detailed report in CSV, JSON, and Cypher formats\n\n---\n\n## ✅ Requirements\n\n- [Rust (stable)](https://www.rust-lang.org/tools/install)\n- Git (to clone the repository)\n- Internet access (to reach the OUTSCALE public API)\n\n---\n\n## ⚙️ Install\n\n### from source\n\n#### 1. Install Rust\n\nIf Rust is not already installed:\n\n```bash\ncurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n```\n\n#### 2. Clone the repository\n\n```bash\ngit clone https://github.com/outscale/uar\ncd uar\n```\n\n#### 3. Update dependencies\n\n```bash\ncargo update\n```\n\n#### 4. Build the project\n\n```bash\ncargo build --release\n```\n\n#### 5. Install locally\n\n```bash\ncargo install --path .\n```\n\n### from pre-compiled binaries\n\nAlternatively, you may find pre-compiled binaries to download on the [releases page](https://github.com/outscale/UAR/releases/).  \n\n---\n\n## 🚀 Usage\n\nUAR requires **three mandatory parameters** for authentication and region:\n\n- `--osc-access-key` or environment variable `OSC_ACCESS_KEY`\n- `--osc-secret-key` or environment variable `OSC_SECRET_KEY`\n- `--osc-region` or environment variable `OSC_REGION`\n\n### Basic command\n\n```bash\nuar\n```\n\n### Optional filters\n\nFilter by user ID and/or resource ID:\n\n```bash\nuar --osc-user-id Alice --osc-resource-id vol-493d8cd0\n```\n\nCustomize the output path and file name (default: `uar_report`):\n\n```bash\nuar --report-path /reports/my_custom_report\n```\n\nLimit the number of resources shown in CLI (default: 10):\n\n```bash\nuar --max-resources-display-on-cli 5\n```\n\n---\n\n## 📦 Report Output\n\nBy default, reports are saved in the current directory with the following files:\n\n- `uar_report.csv`\n- `uar_report.json`\n- `uar_report.cypher`\n\nThese can be renamed or redirected with the `--report-path` option.\n\n---\n\n## 🔐 Authorization Review\n\nTo ensure accurate and complete results, use credentials from:\n- An OUTSCALE account **or**\n- An EIM user with wide read access (e.g., `Allow api::Read*`)\n\n\u003e ⚠️ If insufficient permissions are used, the report may be incomplete or empty.\n\n### Access Control Rules to Remember\n\n1. **Implicit Deny**: Any action not explicitly allowed is denied.\n2. **Explicit Deny**: If both `Allow` and `Deny` exist, the **Deny** always overrides the Allow.\n\n---\n\n## 🤝 Contributing\n\nWe welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fuar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fuar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fuar/lists"}