monkey365

0.95.1

core/api/m365/SharePointOnline/csom/helpers/web/Get-MonkeyCSOMWeb.ps1

# Monkey365 - the PowerShell Cloud Security Tool for Azure and Microsoft 365 (copyright 2022) by Juan Garrido
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

Function Get-MonkeyCSOMWeb{
    <#
        .SYNOPSIS
 
        .DESCRIPTION
 
        .INPUTS
 
        .OUTPUTS
 
        .EXAMPLE
 
        .NOTES
            Author : Juan Garrido
            Twitter : @tr1ana
            File Name : Get-MonkeyCSOMWeb
            Version : 1.0
 
        .LINK
            https://github.com/silverhack/monkey365
    #>
    [cmdletbinding()]
    #[OutputType([System.Collections.Generic.List[System.Management.Automation.PSObject]])]
    Param (
        [parameter(Mandatory=$false, HelpMessage="Authentication Object")]
        [Object]$Authentication,

        [parameter(Mandatory=$false, ValueFromPipeline = $true, HelpMessage="Endpoint")]
        [String]$Endpoint,

        [parameter(Mandatory=$false, HelpMessage="Recursive search")]
        [Switch]$Recurse,

        [parameter(Mandatory=$false, HelpMessage="All SharePoint web objects")]
        [Switch]$All,

        [Parameter(Mandatory= $false, HelpMessage="Includes")]
        [string[]]$Includes,

        [Parameter(Mandatory=$false, HelpMessage="Subsite depth limit recursion")]
        [int32]$Limit = 10
    )
    Begin{
        $select_all_properties = @(
            'Folder','Lists',
            'RoleDefinitionBindings',
            'Member','ParentList',
            'RoleAssignments','File',
            'RootFolder','Webs'
        )
        #Get PNPWeb
        [xml]$body_data = '<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="Monkey365" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1"/><ObjectPath Id="4" ObjectPathId="3"/><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"></Query></Query></Actions><ObjectPaths><StaticProperty Id="1" TypeId="{3747adcd-a3c3-41b9-bfab-4a64dd2f1e0a}" Name="Current"/><Property Id="3" ParentId="1" Name="Web"/></ObjectPaths></Request>'
        #Set properties
        $properties = $body_data.CreateElement("Properties", $body_data.NamespaceURI)
        #Check if includes
        if($PSBoundParameters.ContainsKey('Includes') -and $PSBoundParameters['Includes']){
            foreach($include in $PSBoundParameters['Includes']){
                $prop = $body_data.CreateNode([System.Xml.XmlNodeType]::Element, $body_data.Prefix, 'Property', $body_data.NamespaceURI);
                #Set attributes
                [void]$prop.SetAttribute('Name',$include)
                if($include -in $select_all_properties){
                    [void]$prop.SetAttribute('SelectAll','true')
                }
                else{
                    [void]$prop.SetAttribute('ScalarProperty','true')
                }
                [void]$properties.AppendChild($prop)
            }
        }
        [void]$body_data.Request.Actions.Query.Query.AppendChild($properties)
        [xml]$body_data = $body_data.OuterXml.Replace(" xmlns=`"`"", "")
    }
    Process{
        if($PSBoundParameters.ContainsKey('All') -and $PSBoundParameters['All'].IsPresent){
            $p = Set-CommandParameter -Command "Get-MonkeyCSOMSiteProperty" -Params $PSBoundParameters
            $Urls = @(Get-MonkeyCSOMSiteProperty @p).Where({$_.Template -notlike "SRCHCEN#0" -and $_.Template -notlike "SPSMSITEHOST*" -and $_.Template -notlike "RedirectSite#0"}) | Select-Object -ExpandProperty Url -ErrorAction Ignore
            if($null -ne $Urls){
                #Remove All param
                [void]$PSBoundParameters.Remove('All');
                @($Urls).ForEach({Get-MonkeyCSOMWeb -Endpoint $_ @PSBoundParameters}).Where({$null -ne $_})
            }
        }
        Else{
            $p = Set-CommandParameter -Command "Invoke-MonkeyCSOMRequest" -Params $PSBoundParameters
            #Add authentication header if missing
            if(!$p.ContainsKey('Authentication')){
                if($null -ne $O365Object.auth_tokens.SharePointOnline){
                    [void]$p.Add('Authentication',$O365Object.auth_tokens.SharePointOnline);
                }
                Else{
                    Write-Warning -Message ($message.NullAuthenticationDetected -f "SharePoint Online")
                    break
                }
            }
            #Add post Data
            [void]$p.Add('Data',$body_data);
            #Execute command
            $Web = Invoke-MonkeyCSOMRequest @p
            if($null -ne $Web){
                #return web
                Write-Output $Web
                if($PSBoundParameters.ContainsKey('Includes') -and $PSBoundParameters['Includes']){
                    #Remove childitem
                    foreach($include in $PSBoundParameters['Includes']){
                        if($null -ne $Web.($include) -and $null -ne $Web.($include).PsObject.Properties.Item('_Child_Items_')){
                            $Web.($include) = $Web.($include)._Child_Items_
                        }
                    }
                }
                #Check if recurse
                If($PSBoundParameters.ContainsKey('Recurse') -and $PSBoundParameters['Recurse'].IsPresent){
                    $msg = @{
                        MessageData = ($message.SharepointSubSitesMessage -f $Web.Url);
                        callStack = (Get-PSCallStack | Select-Object -First 1);
                        logLevel = 'info';
                        InformationAction = $O365Object.InformationAction;
                        Tags = @('MonkeyCSOMSubsiteSearch');
                    }
                    Write-Information @msg
                    $p = Set-CommandParameter -Command "Get-MonkeyCSOMSubWeb" -Params $PSBoundParameters
                    #Add Web object
                    [void]$p.Add('Web',$Web);
                    #Remove endpoint if exists
                    [void]$p.Remove('Endpoint');
                    #Execute query
                    Get-MonkeyCSOMSubWeb @p
                }
            }
        }
    }
    End{
        #Nothing to do here
    }
}