Skip to content

Commit

Permalink
Merge pull request #102 from SamErde/dev-readme-updates-01
Browse files Browse the repository at this point in the history 
because a repo isn't complete until it has badges!
  • Loading branch information
@TrimarcJake
TrimarcJake authored Jan 19, 2024
2 parents 3a7b6c4 + e81aa75 commit c85964e
Showing 1 changed file with 50 additions and 13 deletions.
63 changes: 50 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,26 @@
_ _____ _______ _ _ _______ _______ _____ _______ _ _
| | | | |____/ |______ | | | | | |_____|
|_____ |_____| |_____ | \_ ______| | | | __|__ | | |
.--. .--. .--.
.--. .--. .--.
/.-. '----------. /.-. '----------. /.-. '----------.
\'-' .---'-''-'-' \'-' .--'--''-'-' \'-' .--'--'-''-'
'--' '--' '--'
'--' '--' '--'
```

A ~~tiny~~ small tool built to detect and fix common misconfigurations in Active Directory Certificate Services.

<!-- locksmith-badges-start -->
![GitHub release](https://img.shields.io/github/v/release/trimarcjake/locksmith?sort=semver)
![GitHub top language](https://img.shields.io/github/languages/top/trimarcjake/locksmith)
![PowerShell Gallery Platform Support](https://img.shields.io/powershellgallery/p/locksmith)
[![GitHub contributors](https://img.shields.io/github/contributors/trimarcjake/locksmith.svg)](https://github.com/trimarcjake/locksmith/graphs/contributors/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/trimarcjake/Locksmith/powershell.yml?logo=github&label=PSScriptAnalyzer)
[![MegaLinter](https://github.com/trimarcjake/locksmith/workflows/MegaLinter/badge.svg?branch=testing)](https://github.com/trimarcjake/locksmith/actions?query=workflow%3AMegaLinter+branch%3Atesting)
![PowerShell Gallery Downloads](https://img.shields.io/powershellgallery/dt/locksmith?logo=powershell&label=PowerShell%20Gallery%20Downloads&color=blue)
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Checkout+Locksmith+and+fix+common+misconfigurations+in+Active+Directory+Certificate+Services.&url=https://github.com/trimarcjake/locksmith&hashtags=ADCS,PKI,infosec,powershell)
<!-- locksmith-badges-end -->

# Contents
1. [Installation](#Installation)
2. [Run Locksmith](#RunLocksmith)
Expand All @@ -27,7 +39,7 @@ A ~~tiny~~ small tool built to detect and fix common misconfigurations in Active
### Install module manually from GitHub:
1. Download the [latest module version](https://github.com/TrimarcJake/Locksmith/releases/latest) ( **Locksmith-v**\<YEAR\>**.**\<MONTH\>**.zip** )
2. Extract the downloaded zip file
3. Open a PowerShell prompt to the loction of the extracted file and run `Import-Module Locksmith.psd1`
3. Open a PowerShell prompt to the location of the extracted file and run `Import-Module Locksmith.psd1`

## Script
### Download the standalone script (classic) without module:
Expand All @@ -42,11 +54,11 @@ A ~~tiny~~ small tool built to detect and fix common misconfigurations in Active
Running `Invoke-Locksmith.ps1` with no parameters or with `-Mode 0` will scan the current Active Directory forest and output all discovered AD CS issues to the console in **Table** format.
``` powershell
# Module Syntax
PS> Invoke-Locksmith
Invoke-Locksmith
```
``` powershell
# Script Syntax
PS> .\Invoke-Locksmith.ps1
.\Invoke-Locksmith.ps1
```

Example Output for Mode 0: https://github.com/TrimarcJake/Locksmith/blob/main/examples/Mode0.md
Expand All @@ -57,11 +69,11 @@ Example Output for Mode 0: https://github.com/TrimarcJake/Locksmith/blob/main/ex
This mode scans the current forest and outputs all discovered AD CS issues and possible fixes to the console in **List** format.
``` powershell
# Module Syntax
PS> Invoke-Locksmith -Mode 1
Invoke-Locksmith -Mode 1
```
``` powershell
# Script Syntax
PS> .\Invoke-Locksmith.ps1 -Mode 1
.\Invoke-Locksmith.ps1 -Mode 1
```

Example Output for Mode 1: https://github.com/TrimarcJake/Locksmith/blob/main/examples/Mode1.md
Expand All @@ -72,11 +84,11 @@ Example Output for Mode 1: https://github.com/TrimarcJake/Locksmith/blob/main/ex
Locksmith Mode 2 scans the current forest and outputs all discovered AD CS issues to ADCSIssues.CSV in the present working directory.
``` powershell
# Module Syntax
PS> Invoke-Locksmith -Mode 2
Invoke-Locksmith -Mode 2
```
``` powershell
# Script Syntax
PS> .\Invoke-Locksmith.ps1 -Mode 2
.\Invoke-Locksmith.ps1 -Mode 2
```

Example Output for Mode 2: https://github.com/TrimarcJake/Locksmith/blob/main/examples/Mode2.md
Expand All @@ -87,11 +99,11 @@ Example Output for Mode 2: https://github.com/TrimarcJake/Locksmith/blob/main/ex
In Mode 3, Locksmith scans the current forest and outputs all discovered AD CS issues and example fixes to ADCSRemediation.CSV in the present working directory.
``` powershell
# Module Syntax
PS> Invoke-Locksmith -Mode 3
Invoke-Locksmith -Mode 3
```
``` powershell
# Script Syntax
PS> .\Invoke-Locksmith.ps1 -Mode 3
.\Invoke-Locksmith.ps1 -Mode 3
```

Example Output for Mode 3: https://github.com/TrimarcJake/Locksmith/blob/main/examples/Mode3.md
Expand All @@ -102,11 +114,36 @@ Example Output for Mode 3: https://github.com/TrimarcJake/Locksmith/blob/main/ex
Mode 4 is the "easy button." Running Locksmith in Mode 4 will identify all misconfigurations and offer to fix each issue. If there is any possible operational impact, Locksmith will warn you.
``` powershell
# Module Syntax
PS> Invoke-Locksmith -Mode 4
Invoke-Locksmith -Mode 4
```
``` powershell
# Script Syntax
PS> .\Invoke-Locksmith.ps1 -Mode 4
.\Invoke-Locksmith.ps1 -Mode 4
```

Example Output for Mode 4: https://github.com/TrimarcJake/Locksmith/blob/main/examples/Mode4.md
<br>
<br>
<a name="Scans" id="Scans"></a>
## Scans:  Select Which Scans to Run
Use the `-Scans` parameter to choose which vulnerabilities to scan for. Acceptable values include `All`, `Auditing`, `ESC1`, `ESC2`, `ESC3`, `ESC4`, `ESC5`, `ESC6`, `ESC8`, or `PromptMe`. The `PromptMe` option presents an interactive list allowing you to select scans.

``` powershell
# Run all scans
Invoke-Locksmith -Scan All
```

``` powershell
# Prompt the user for a list of scans to select
Invoke-Locksmith.ps1 -Scans PromptMe
```

``` powershell
# Scan for ESC1 vulnerable paths
Invoke-Locksmith.ps1 -Scans ESC1
```

``` powershell
# Scan for ESC1, ESC2, and ESC8 vulnerable paths
Invoke-Locksmith.ps1 -Scans ESC1,ESC2,ESC8
```

0 comments on commit c85964e

Please sign in to comment.