diff --git a/.gitignore b/.gitignore index 8b76e23..b4b4b54 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ # Azure Automation Common Runbook Framework -# https://github.com/Workoho/AzAuto-Common-Runbook-FW +# https://github.com/workoho/AzAuto-Common-Runbook-FW setup/AzAutoFWProject/* scripts/AzAutoFWProject/* !scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1 diff --git a/README.md b/README.md index 83feb6c..5b772a8 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@
- + Logo @@ -33,16 +33,16 @@

Implement a powerful Tiering Security Model in Microsoft Entra for your Cloud Administrator identities using Azure Automation.
- Explore the docs » + Explore the docs »
[![Open template in GitHub Codespaces](https://img.shields.io/badge/Open%20in-GitHub%20Codespaces-blue?logo=github)](https://codespaces.new/Workoho/Entra-Tiering-Security-Model)     [![View template online in Visual Studio Code](https://img.shields.io/badge/View%20Online%20in-Visual%20Studio%20Code-blue?logo=visual-studio-code)](https://vscode.dev/github/Workoho/Entra-Tiering-Security-Model)
-Report Bug +Report Bug · -Request Feature +Request Feature

@@ -119,7 +119,7 @@ The following graphic illustrates the lifecycle concept at a high level: ## Getting Started -The entire setup is fully automatic (thanks to the amazing [Azure Automation Common Runbook Framework](https://github.com/Workoho/AzAuto-Common-Runbook-FW)), but requires some preparation and decision making to start. +The entire setup is fully automatic (thanks to the amazing [Azure Automation Common Runbook Framework](https://github.com/workoho/AzAuto-Common-Runbook-FW)), but requires some preparation and decision making to start. [![asciicast](https://asciinema.org/a/646552.svg)](https://asciinema.org/a/646552) _Preview of the setup procedure_ @@ -175,7 +175,7 @@ The following steps only need to be performed once to get you started: $CORP='CORP' mkdir $CORP cd $CORP - git clone https://github.com/Workoho/Entra-Tiering-Security-Model.git $CORP.Entra-Tiering-Security-Model + git clone https://github.com/workoho/Entra-Tiering-Security-Model.git $CORP.Entra-Tiering-Security-Model cd $CORP.Entra-Tiering-Security-Model # Rename the Visual Studio Code workspace @@ -241,10 +241,12 @@ The following steps only need to be performed once to get you started: This file typically exists on your local machine only. It may contain parts of the configuration that you consider to be confidential for your company. - Copy the configuration template from `./config/AzAutoFwProject/AzAutoFWProject.local.psd1.tmpl` to `./config/AzAutoFwProject/AzAutoFWProject.local.psd1`: + The `Update-AzAutoFWProject.ps1` script you ran before already should have created a copy for you but you may also do this manually: + + Copy the configuration template from `./config/AzAutoFwProject/AzAutoFWProject.local.template.psd1` to `./config/AzAutoFwProject/AzAutoFWProject.local.psd1`: ```powershell - copy ./config/AzAutoFWProject/AzAutoFWProject.local.psd1.tmpl ./config/AzAutoFWProject/AzAutoFWProject.local.psd1 + copy ./config/AzAutoFWProject/AzAutoFWProject.local.template.psd1 ./config/AzAutoFWProject/AzAutoFWProject.local.psd1 ``` Please note that by default, this configuration file is ignored by the Git repository to avoid accidential leaks of potential sensitive information. @@ -253,6 +255,14 @@ The following steps only need to be performed once to get you started: This file is part of your Git project repository and subject to tracking of changes. Essential parts of the configuration are done in this file where the general information is not considered a secret and its content is to be shared with everyone with access to your Git repository. + The `Update-AzAutoFWProject.ps1` script you ran before already should have created a copy for you but you may also do this manually: + + Copy the configuration template from `./config/AzAutoFwProject/AzAutoFWProject.template.psd1` to `./config/AzAutoFwProject/AzAutoFWProject.psd1`: + + ```powershell + copy ./config/AzAutoFWProject/AzAutoFWProject.template.psd1 ./config/AzAutoFWProject/AzAutoFWProject.psd1 + ``` + **Important:** Some parts of the configuration may be moved between the two files. However, it is not a general concept and is only supported where it is explicitly explained. 5. Open `./config/AzAutoFWProject/AzAutoFWProject.local.psd1` in your favorite editor. @@ -303,6 +313,8 @@ The following steps only need to be performed once to get you started: cd - ``` + Attention: Make sure that you are actually adding the `.zip` file, _not_ the plain `.psd1` file (fans using [tab completion](https://learn.microsoft.com/en-us/powershell/scripting/learn/shell/tab-completion) might know what I mean). + Of course, you must remember the password. We recommend using a password manager to generate a long random password. If you ever want to use this file on a different machine, you will need this password to unpack the file. @@ -591,7 +603,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. - Julian Pawlowski - [@jpawlowski](https://github.com/jpawlowski) -Project Link: [https://github.com/Workoho/Entra-Tiering-Security-Model](https://github.com/Workoho/Entra-Tiering-Security-Model) +Project Link: [https://github.com/workoho/Entra-Tiering-Security-Model](https://github.com/workoho/Entra-Tiering-Security-Model)

(back to top)

@@ -599,17 +611,17 @@ Project Link: [https://github.com/Workoho/Entra-Tiering-Security-Model](https:// [contributors-shield]: https://img.shields.io/github/contributors/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge -[contributors-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/graphs/contributors +[contributors-url]: https://github.com/workoho/Entra-Tiering-Security-Model/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge -[forks-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/network/members +[forks-url]: https://github.com/workoho/Entra-Tiering-Security-Model/network/members [stars-shield]: https://img.shields.io/github/stars/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge -[stars-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/stargazers +[stars-url]: https://github.com/workoho/Entra-Tiering-Security-Model/stargazers [issues-shield]: https://img.shields.io/github/issues/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge -[issues-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/issues +[issues-url]: https://github.com/workoho/Entra-Tiering-Security-Model/issues [license-shield]: https://img.shields.io/github/license/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge -[license-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/blob/master/LICENSE.txt +[license-url]: https://github.com/workoho/Entra-Tiering-Security-Model/blob/master/LICENSE.txt [AzAutoFW]: https://img.shields.io/badge/Azure_Automation_Framework-1F4386?style=for-the-badge&logo=microsoftazure&logoColor=white -[AzAutoFW-url]: https://github.com/Workoho/AzAuto-Common-Runbook-FW +[AzAutoFW-url]: https://github.com/workoho/AzAuto-Common-Runbook-FW [GitHubCodespaces]: https://img.shields.io/badge/GitHub_Codespaces-09091E?style=for-the-badge&logo=github&logoColor=white [GitHubCodespaces-url]: https://github.com/features/codespaces [VScode]: https://img.shields.io/badge/Visual_Studio_Code-2C2C32?style=for-the-badge&logo=visualstudiocode&logoColor=3063B4 diff --git a/Runbooks/CloudAdmin_0000__Common_0000__Get-ConfigurationConstants.ps1 b/Runbooks/CloudAdmin_0000__Common_0000__Get-ConfigurationConstants.ps1 index ad05d72..1887c79 100644 --- a/Runbooks/CloudAdmin_0000__Common_0000__Get-ConfigurationConstants.ps1 +++ b/Runbooks/CloudAdmin_0000__Common_0000__Get-ConfigurationConstants.ps1 @@ -5,12 +5,12 @@ .COMPANYNAME Workoho GmbH .COPYRIGHT © 2024 Workoho GmbH .TAGS -.LICENSEURI https://github.com/Workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt -.PROJECTURI https://github.com/Workoho/Entra-Tiering-Security-Model +.LICENSEURI https://github.com/workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt +.PROJECTURI https://github.com/workoho/Entra-Tiering-Security-Model .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS -.EXTERNALSCRIPTDEPENDENCIES https://github.com/Workoho/AzAuto-Common-Runbook-FW +.EXTERNALSCRIPTDEPENDENCIES https://github.com/workoho/AzAuto-Common-Runbook-FW .RELEASENOTES 2024-01-16 - Initial release. #> diff --git a/Runbooks/CloudAdmin_0100__New-CloudAdministrator-Account-V1.ps1 b/Runbooks/CloudAdmin_0100__New-CloudAdministrator-Account-V1.ps1 index f4e7910..b8eb59a 100644 --- a/Runbooks/CloudAdmin_0100__New-CloudAdministrator-Account-V1.ps1 +++ b/Runbooks/CloudAdmin_0100__New-CloudAdministrator-Account-V1.ps1 @@ -5,12 +5,12 @@ .COMPANYNAME Workoho GmbH .COPYRIGHT © 2024 Workoho GmbH .TAGS TieringModel CloudAdministrator Identity Microsoft365 Security Azure Automation AzureAutomation -.LICENSEURI https://github.com/Workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt -.PROJECTURI https://github.com/Workoho/Entra-Tiering-Security-Model +.LICENSEURI https://github.com/workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt +.PROJECTURI https://github.com/workoho/Entra-Tiering-Security-Model .ICONURI .EXTERNALMODULEDEPENDENCIES Microsoft.Graph,Microsoft.Graph.Beta,Az .REQUIREDSCRIPTS CloudAdmin_0000__Common_0000__Get-ConfigurationConstants.ps1 -.EXTERNALSCRIPTDEPENDENCIES https://github.com/Workoho/AzAuto-Common-Runbook-FW +.EXTERNALSCRIPTDEPENDENCIES https://github.com/workoho/AzAuto-Common-Runbook-FW .RELEASENOTES 2024-01-16 - Initial release. #> diff --git a/SECURITY.md b/SECURITY.md index d11b30a..c9f58b2 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -11,7 +11,7 @@ If you believe you have found a security vulnerability or would like to suggest **Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the project team by opening a security advisory here: -https://github.com/Workoho/Entra-Tiering-Security-Model/security/advisories/new +https://github.com/workoho/Entra-Tiering-Security-Model/security/advisories/new As an alternative, you may also report them to the Workoho Security Team by email to [secure@workoho.com](mailto:secure@workoho.com). If desired, you may also encrypt your message with our PGP key; please see [Workoho's Security.txt file](https://workoho.com/.well-known/security.txt) for further details. diff --git a/config/AzAutoFWProject/AzAutoFWProject.template.psd1 b/config/AzAutoFWProject/AzAutoFWProject.template.psd1 index 0bcbed5..1c05754 100644 --- a/config/AzAutoFWProject/AzAutoFWProject.template.psd1 +++ b/config/AzAutoFWProject/AzAutoFWProject.template.psd1 @@ -11,7 +11,7 @@ GitReference = 'ModuleVersion' # GitRepositoryUrl must be a valid Git repository URL. You likely don't want to change this unless you're forking the framework. - GitRepositoryUrl = 'https://github.com/Workoho/AzAuto-Common-Runbook-FW.git' + GitRepositoryUrl = 'https://github.com/workoho/AzAuto-Common-Runbook-FW.git' # Files belonging to the framework are usually symlinked to the child project to keep them up to date. # On Windows, this requires SeCreateSymbolicLinkPrivilege to be enabled, or manually running the Update-AzAutoFWProjectRunbooks.ps1 script as an administrator. diff --git a/scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1 b/scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1 index 0716947..0a63c1c 100644 --- a/scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1 +++ b/scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1 @@ -5,8 +5,8 @@ .COMPANYNAME Workoho GmbH .COPYRIGHT © 2024 Workoho GmbH .TAGS -.LICENSEURI https://github.com/Workoho/AzAuto-Project.tmpl/LICENSE.txt -.PROJECTURI https://github.com/Workoho/AzAuto-Project.tmpl +.LICENSEURI https://github.com/workoho/AzAuto-Project.tmpl/LICENSE.txt +.PROJECTURI https://github.com/workoho/AzAuto-Project.tmpl .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS