From e4277afdb77dc9457d557038a015821b375b8279 Mon Sep 17 00:00:00 2001 From: DrIOS <58635327+DrIOSX@users.noreply.github.com> Date: Sun, 7 Jul 2024 17:15:26 -0500 Subject: [PATCH] docs: Update Help README/HTML --- README copy.md | 93 ++++++++++++----------------------------- README.md | Bin 45446 -> 50704 bytes docs/index.html | Bin 117106 -> 119504 bytes helpers/Build-Help.ps1 | 1 + 4 files changed, 27 insertions(+), 67 deletions(-) diff --git a/README copy.md b/README copy.md index 962380e..1fbe43c 100644 --- a/README copy.md +++ b/README copy.md @@ -13,81 +13,40 @@ For full license details, please visit [Creative Commons Attribution-NonCommerci [Register for and download CIS Benchmarks](https://www.cisecurity.org/cis-benchmarks) ## Invoke-M365SecurityAudit -### Synopsis -Invokes a security audit for Microsoft 365 environments. -### Syntax + +# EXAMPLES ```powershell +# Example 1: Performing a security audit based on CIS benchmarks +$auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" +$auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -ApprovedCloudStorageProviders "DropBox" -ApprovedFederatedDomains "northwind.com" -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] +# Example 2: Exporting a security audit and it's nested tables to zipped CSV files +Export-M365SecurityAuditTable -AuditResults $auditResults -ExportPath "C:\temp" -ExportOriginalTests -ExportAllTests + # Output Ex: 2024.07.07_14.55.55_M365FoundationsAudit_368B2E2F.zip -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-ELevel ] [-ProfileLevel ] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] - -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-IncludeIG1] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] - -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-IncludeIG2] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] - -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-IncludeIG3] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] - -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-IncludeRecommendation ] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] - -Invoke-M365SecurityAudit -TenantAdminUrl -DomainName [-SkipRecommendation ] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-WhatIf] [-Confirm] [] +# Example 3: Retrieving licenses for users in administrative roles +Get-AdminRoleUserLicense +# Example 4: Getting MFA status of users +Get-MFAStatus -UserId "user@domain.com" +# Example 5: Removing rows with empty status values from a CSV file +Remove-RowsWithEmptyCSVStatus -FilePath "C:\Reports\Report.xlsx" -WorksheetName "Sheet1" +# Example 6: Synchronizing CIS benchmark data with audit results +Sync-CISExcelAndCsvData -ExcelPath "path\to\excel.xlsx" -CsvPath "path\to\data.csv" -SheetName "Combined Profiles" +# Example 7: Granting Microsoft Graph permissions to the auditor +Grant-M365SecurityAuditConsent -UserPrincipalNameForConsent 'user@example.com' ``` -### Parameters -| Name | Alias | Description | Required? | Pipeline Input | Default Value | -| - | - | - | - | - | - | -| TenantAdminUrl | | The URL of the tenant admin. This parameter is mandatory. | true | false | | -| DomainName | | The domain name of the Microsoft 365 environment. This parameter is mandatory. | true | false | | -| ELevel | | Specifies the E-Level \(E3 or E5\) for the audit. This parameter is optional and can be combined with the ProfileLevel parameter. | false | false | | -| ProfileLevel | | Specifies the profile level \(L1 or L2\) for the audit. This parameter is optional and can be combined with the ELevel parameter. | false | false | | -| IncludeIG1 | | If specified, includes tests where IG1 is true. | false | false | False | -| IncludeIG2 | | If specified, includes tests where IG2 is true. | false | false | False | -| IncludeIG3 | | If specified, includes tests where IG3 is true. | false | false | False | -| IncludeRecommendation | | Specifies specific recommendations to include in the audit. Accepts an array of recommendation numbers. | false | false | | -| SkipRecommendation | | Specifies specific recommendations to exclude from the audit. Accepts an array of recommendation numbers. | false | false | | -| DoNotConnect | | If specified, the cmdlet will not establish a connection to Microsoft 365 services. | false | false | False | -| DoNotDisconnect | | If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. | false | false | False | -| NoModuleCheck | | If specified, the cmdlet will not check for the presence of required modules. | false | false | False | -| WhatIf | wi | | false | false | | -| Confirm | cf | | false | false | | -### Inputs - - None. You cannot pipe objects to Invoke-M365SecurityAudit. -### Outputs - - CISAuditResult\\[\] The cmdlet returns an array of CISAuditResult objects representing the results of the security audit. +# NOTE +Ensure that you have the necessary permissions and administrative roles in your Microsoft 365 environment to run these cmdlets. Proper configuration and setup are required for accurate audit results. -### Note -This module is based on CIS benchmarks and is governed by the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. For more details, visit: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en +# TROUBLESHOOTING NOTE +If you encounter any issues while using the cmdlets, ensure that your environment meets the module prerequisites. Check for any updates or patches that may address known bugs. For issues related to specific cmdlets, refer to the individual help files for troubleshooting tips. -### Examples -**EXAMPLE 1** -```powershell -Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -ELevel "E5" -ProfileLevel "L1" -``` -Performs a security audit for the E5 level and L1 profile in the specified Microsoft 365 environment. - -**EXAMPLE 2** -```powershell -Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -IncludeIG1 -``` -Performs an audit including all tests where IG1 is true. - -**EXAMPLE 3** -```powershell -Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -SkipRecommendation '1.1.3', '2.1.1' -``` -Performs an audit while excluding specific recommendations 1.1.3 and 2.1.1. - -**EXAMPLE 4** -```powershell -$auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -PS> $auditResults | Export-Csv -Path "auditResults.csv" -NoTypeInformation -``` -Captures the audit results into a variable and exports them to a CSV file. - -### Links - - - [Online Version: [GitHub Repository URL]](#Online Version: [GitHub Repository URL]) +# SEE ALSO +- [CIS Benchmarks](https://www.cisecurity.org/cis-benchmarks/) +- [Microsoft 365 Security Documentation](https://docs.microsoft.com/en-us/microsoft-365/security/) +- [PowerShell Documentation](https://docs.microsoft.com/en-us/powershell/) \ No newline at end of file diff --git a/README.md b/README.md index 4c04a533ac7e357cb0af9501d47f91d77568f386..9c9dd2911d42213dd57e8cd123b95f6257b0c26c 100644 GIT binary patch delta 3115 zcmb7GU2IfE6rN?J6b(P6Zt6k{(`}$7ZRrm!LIKO#7DOoButhWw+S}dj4{Z0pwva-j zAv_pkY)%DkwRNTloOG0)5+9^EHkl?y%Pgc_Y5y>rWlskc8$!ykx++PO&e@g!(wV%mJq<{J)Gh;)XPiQ3R3%B4xB%jT>Y%cA+F=WYCs-ZQBvwXHDIUqm|5| zPs2SLJ_NNK9t-8BJ^tz>jFcK+VqfXrB!52hlm%9!ky8s) z2KExLYN2{~G$?l_Hh95aah~my(6Js*qjU_`H#8dFjw(KdT$*w^2L22q*97#3TYg!w z|KLi)TV|(p>*^Ou;}`}Thtvr$*R%!o9A=E{ zusQ}hX}p)?gp6de5i#vd8KWbP)>|S#8cZRUEWTJC&mvx%4@1QYOjzp4Y|W~yYJqx8 ze!Nw)%7v=xxPL(dmKYv_;sQol5@5|3xHQ6N(8a*BuuDfQjC}^=h&qS$MJTL$gwB%6 zI>@F)d!!jz7@J()mLhKKn7AA)i<&JNpN4UEyji?8SU7_m+073^N|WU{(ABuv#O-5A z`6=#ODCYnHq2{;=&h2lOGnQ5CIV?#+!2;7J)VSe8k@>~2*=v|5w`WdbmPA}84NAA0 zVam8(N{uk+JpkiDP$LW)@LMb9r{t^oI_a-?VNILbULw60^vO5b%H}W}w}fLpNQZuG zM+tLEvJliM$P!X@-FGf(z7n`;NF&DCEM()*a*vNTv$7R7va0Q0^jb{=?#4G3N9pcm zJ}#zf{Qv1p$NzRl9&Yh@+Va;cW(VcM*pjrId^^AIM32YI&hTKQLDmnC%KfqSe9OsC zJ=Dn0zf>4}eX201J#+UT`o>VZ(^U2$e}Amj>phG*cBUGRup7or{_SZp0sh%KWaH)e z!mQf@BGKJq;(6)zB6gR!Ixp$o#s$Vsrjr-!M8mM=t_mU@WMl+Z$X<5QPH1)Dw+FDh zx~-s00yZqy`qdG1jX_i7)ZA%Slxl~d%UYUM$+K`OiiX2Okzv@&fo*6ZxMmN?^TwFF zbywNeVHl&6K{!d4v6fxVWzkrdZR9-@Q!6CCcEbXzjg`wPFJOTYI~J+Rd%@9yL##8_ zGY>h|aS;n*H3SP>lQCx$HKyq#BdWMR*h%{)^KcjEBA}N4Z5@PJEAKcfL%6Wy4(nR^Z1R!oj5{~)bmfteCn5u zQi41>Qa2vZM}pI>ay8wuHwXsVE1Bsp#&9{2-BwPLN3boga7c!az)H;SdS(6QCJ9~b zl1s1N%wKq;(qp9g1Jdb{v28ta+ph~ZQ!U>GcHwp!z|Dm1mG@Kr4*_*nn9fI*_Iq$~ sJgu5cWjyKOV delta 426 zcmbQx!`$|mX~QbE%{Ag_zLNur6PS4!xF)YJHk|w~ea2?KG%Lo<2U7ePH&4q@VFXH> zfu;EiKW~1Pg(hH@izd*PuLsr4RHVT;`9R9H%@2y-FijS#RAJ3y$Y&^-EVx^=UV$Nz zA&()2L4hHOp%O@@Fr+f10mVugau`a0{7f)e4y1E{P=TQUC|3-G`e0QcQIH7`xip}u zrBKsSfb3kLOeT80ApX`l6AZ6F0YVu z75@-Ic%9(+VYEaeYGSPA8m}hCm?lPJg5igMOboFEBY_&NqVbR5H+T0gt;EMKVs7re z=ggUz^Uch6=KOpn@6zjer@pLOLyhzht;E|*1~t(dYQeV&-)34ne#6t5XF!g}{G;DFv|9e22Ke1dK?+a^{^6a5lq*=OCPr&*z3Zb(?SJt( zTi>idSLkxKP^-op)$y@P^XT}|#;nja`C++1VIVi)FM`o-jGwh*Nvi3|wjF4ofVt!O}GEmtc=Y)H#=rY)zq~o&Dd|T zg4|7%)L-ZF65Ub9g@GjMAyMr{6mj6*540i~2Kof%$RYm8%y<}*I94Pd!}vz%keYs@ zCN-FeQ!?cvr{WnJ&|@=v1n6lzL&%1B9t3F&5XlGn_-HMN<>)rh2Ked&cOuYhr!BMz zwXKJ?Xg+LPWVKV&KwVHy;5h&&aX9XT*?zonI66o%ge1i4!m5;UfDYNtoUNN@Z5@Iy z0T}>DA<_WInkhPVnCYVxc1g0lK0e0Q!5qFhM;WW#DZ$xq*FT#lNDjb_oB{)oIxrG= z5zNANb`$pOPG)>q*#_rg6Njy6$;k;r=Ga6Lj?5&qz1S}urp)u5GrPnEh=bX&J6ym5z3^^f|AdSjW=nyxKR1z53QVE|Qs= zNR;SmKTFT_-q(%v45&%==%@VbwzcD#H606aRK-?!_2m%1Zx22R@H@^RUvKW=^R~rL zJ^Z5j{d~~wX1cPMU$wqy=QhUTzk*yJyq6%mdS`&to44>s{{`bcO{BH5i|cd#Pp~Z1 zwlQb!*YK} zua|RxzM#e)EiaXONA8gUNYbmz$tSn<12f32`?m5zb!Js%?he{za~v29Yvc)j`yV)F zweH}S!UE?ON~+UqOVvp2{rb!hyY-c0TxLxSanS delta 1033 zcmbu8Ur5tY6vxlmAODQZwkiHeZBC;(mO4`@sVH04gJ_mSWtm%Zxw1K$QX<%di15K| zx4aNxLoC9F#IE=&2wBi$NJT^sVI@JLX10o+g3fPipuJW6_#M9Yd(ZvcbAI>!p52ZQ z2jcsuvaL`AB~VOnDHy;Co1lVXIYn~E=JhoquJ&mbxAkIr{8n(lS=cVVoPL`uUU%J9 zipv)iYee8meKK1dys6v>1~xXH$3nMM*`&b+Zt#H@TEPyTP($$yG(!?-7zQ(#IcQ>z zU_KiN=7=Xjjh4L{D~xTytd4cUc>hun8rbOjhZ`(J^FarkfEH4A(gxCP#FOc6ay&F{ zW<4_n>|$5CSehADvNvCwl=5cQKp8W9ejq-4JcVq>qDoB9`%%1@Gb5#x%PHdVVgZWA zPb-`Qie=O5k@x8_OZ0_JF@^_)>3el##HQybMBxu_B3G#~U+tmF+WBY#rY6b7dcaBL zI-ryHRHEMQhISgBqpDl!F;E9`KR!AK7b)457e(h>MC$kra7Ox-Gdz+0qhG;J*(d2# z#!=*cJ+5X` zb8$Sh4^`5F1}nA9W^3WJXk4nw!2|{O8}Ja@YjZ|GX;OGIK1$?92kQ7x9h&$|9p*FL zY&!Sv!d1*TnZn;4Ml&}ap%C6rq1%QY9<0U*9y*E%yuTjr$m*WdxCa*$D@i%(vdD$e z&Sv~Ij}vb|>aWF@xDxtrXyxfifb)nob&vl@l z1