Merge pull request #7 from jakehildreth/chore/update-readme

chore(docs): update README, LICENSE, and manifest to align with standards

Author: jakehildreth

ADCSGoat/ADCSGoat.psd1

@@ -12,7 +12,7 @@
 RootModule = 'ADCSGoat.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.3.1'
+ModuleVersion = '0.4.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -27,7 +27,7 @@ Author = 'Jake Hildreth'
 CompanyName = 'Gilmour Technologies Ltd'
 
 # Copyright statement for this module
-Copyright = '(c) 2025 Jake Hildreth. All rights reserved.'
+Copyright = '(c) 2026 Jake Hildreth, Gilmour Technologies Ltd. All rights reserved.'
 
 # Description of the functionality provided by this module
 Description = 'A tiny module built for a single purpose: building a small and very insecure AD CS lab.'

LICENSE

@@ -1,6 +1,29 @@
+"Commons Clause" License Condition v1.0
+
+The Software is provided to you by the Licensor under the License, as defined
+below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under the
+License will not include, and the License does not grant to you, the right to
+Sell the Software.
+
+For purposes of the foregoing, "Sell" means practicing any or all of the rights
+granted to you under the License to provide to third parties, for a fee or other
+consideration (including without limitation fees for hosting or
+consulting/support services related to the Software), a product or service whose
+value derives, entirely or substantially, from the functionality of the
+Software. Any license notice or attribution required by the License must also
+include this Commons Clause License Condition notice.
+
+Software: ADCSGoat
+License: MIT
+Licensor: Jake Hildreth, Gilmour Technologies Ltd
+
+---
+
 MIT License
 
-Copyright (c) 2025 Jake Hildreth
+Copyright (c) 2026 Jake Hildreth, Gilmour Technologies Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,7 +4,69 @@ A tiny module built for a single purpose: building a small and very insecure AD
 
 ## Overview
 
+ADCSGoat creates vulnerable Active Directory Certificate Services (AD CS) certificate templates and CA misconfigurations in a lab environment. It deploys the following ESC scenarios:
+
+| Scenario | Description |
+|----------|-------------|
+| ESC1 | Enrollee supplies subject in SAN-enabled template |
+| ESC2 | Overly permissive template allows any purpose |
+| ESC3 (Condition 1) | Enrollment agent template misconfiguration |
+| ESC3 (Condition 2) | Certificate request agent abuse |
+| ESC4 | Vulnerable certificate template ACLs |
+| ESC6 | EDITF_ATTRIBUTESUBJECTALTNAME2 enabled on CA |
+| ESC9 | No security extension on template |
+| ESC11 | IF_ENFORCEENCRYPTICERTREQUEST disabled on CA |
+
+## Prerequisites
+
+- Windows Server with Active Directory and AD CS installed
+- [AutomatedLab](https://automatedlab.org/) (for infrastructure deployment)
+- [PSCertutil](https://github.com/jakehildreth/PSCertutil) module
+- PowerShell 5.1+
+
 ## Installation
 
-## Examples
+```powershell
+Install-Module -Name ADCSGoat
+```
+
+Or clone the repo and import directly:
+
+```powershell
+git clone https://github.com/jakehildreth/ADCSGoat.git
+Import-Module .\ADCSGoat\ADCSGoat\ADCSGoat.psd1
+```
+
+## Quick Start
+
+```powershell
+# Deploy lab infrastructure (Hyper-V + AutomatedLab)
+Deploy-AGInfrastructure
+
+# Install all vulnerable templates and CA misconfigurations
+Install-ADCSGoat
+
+# Clean up when done
+Uninstall-ADCSGoat
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `Deploy-AGInfrastructure` | Deploys a Hyper-V lab using AutomatedLab |
+| `Install-ADCSGoat` | Creates all vulnerable templates and CA misconfigs |
+| `Uninstall-ADCSGoat` | Removes all ADCSGoat templates and reverts CA changes |
+| `Find-AGEnrollmentService` | Queries AD for all Enrollment Services |
+| `New-AGBlankTemplateObject` | Creates blank certificate template objects in AD |
+| `Set-AGTemplateAce` | Adds ACEs to a certificate template |
+| `Set-AGTemplateProperty` | Sets properties on a certificate template |
+| `Set-AGEnrollmentServiceFullName` | Adds a FullName property to an Enrollment Service object |
+
+## License
+
+MIT License w/Commons Clause - see [LICENSE](..\LICENSE) file for details.
+
+---
 
+Made with 💜 by [Jake Hildreth](https://jakehildreth.com)