Archiv für den Monat: März 2020

PowerShell 7-0 und SSH

PowerShell Remoting per SSH ist seit der ersten Version der PowerShell Core möglich und damit nichts Neues mehr. Wirklich gebraucht habe ich es bislang aber noch nicht. Der Newsletter von PowerShell-Experte Adam Betram („Adam the Automator“) hat mich dazu veranlasst, es nach langer Zeit wieder einmal selber auszuprobieren:

https://adamtheautomator.com/ssh-with-powershell/

Das ganze Thema ist sehr gut dokumentiert. Voraussetzung auf der Server-Seite ist natürlich SSH. Bei Linux und MacOS ist SSH fest eingebaut (ich gehe einmal davon aus, dass dies für jede Linux-Distribution gilt), bei Windows 10/Windows Server muss es in Gestalt von Open SSH for Windows eventuell nachträglich hinzugefügt werden:

https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration

Der SSH-Server läuft als Systemdienst mit dem Namen „Sshd“, so dass sich sein Status per Get-Service einfach abfragen lässt. Durch die Installation des SSH Servers wird automatisch eine Firewall-Regel für den Port 22 angelegt.

Der SSH-Client ist im Folgenden eine PowerShell 7.0, die unter Ubuntu 16.04 läuft. Hier muss nichts konfiguriert werden.

Damit eine Verbindung mit dem SSH-Server möglich ist, muss auf dem Computer ein Eintrag zur Konfigurationsdatei sshd_config (ohne Erweiterung) im Verzeichnis C:\ProgramData\ssh hinzugefügt werden.

In einer als Administrator gestarten PowerShell wird die Datei wie folgt geöffnet:

notepad $env:programdata\ssh\sshd_config

Der Eintrag wird unterhalb von „override default of no subsystems“ eingefügt:

Subsystem powershell pwsh.exe -sshs -NoLogo -NoProfile
Abb. 1: PowerShell wird als Subsystem zum SSH Server hinzugefügt

Mehr ist nicht zu tun. Jetzt kann von einem Remote-Computer per PowerShell eine Remote-Verbindung per SSH hergestellt werden:

enter-pssession -Hostname minipc -SSHTransport

Der Parameter SSHTransport sorgt dafür, dass anstelle von WsMan SSH verwendet wird. „minipc“ ist in diesem Beispiel der Name des Windows-PCs mit SSH Server. Auch eine SSH-Session wird per exit verlassen.

Insgesamt ist es erfreulich, wie einfach sich eine PowerShell-Remoting-Session per SSH anlegen lässt.

Generische Methoden aufrufen

Eine generische Methode ist eine Methode, der neben den (optionalen) Parameterwerten beim Aufruf auch ein Typ übergeben wird. Alle generischen Datentypen, die innerhalb der Methode verwendet werden inklusive dem Rückgabewert (sofern vorhanden), verwenden dann diesen Typ. Damit wird mehr Flexibilität erreicht, da die Methode nicht für jeden in Frage kommenden Datentyp überladen werden muss.

Das klassische Beispiel für eine generische Methode void swap<T>(T arg1, T arg2), welche zwei als Referenz übergebene Werte vertauscht. Mit ihr lassen sich Werte eines beliebigen Datentyps vertauschen, da dieser beim Aufruf der Methode ebenfalls angegeben wird:

swap(out a1, out a2)

In PowerShell kann man keine generischen Functions definieren und es würde auch keinen Sinn ergeben. Generische Methoden kommen immer dann ins Spiel, wenn eine Funktionalität einer externen Assembly-Bibliothek genutzt werden soll.

Dabei muss zwischen dem Aufruf einer statischen Methode und einer Instanzmethode unterschieden werden.

Es gibt im Internet (seit 2007) natürlich sehr viele Lösungen, von denen die meisten auch gut funktionieren. Eine sehr gute Lösung ist das Skript von David Wyatt, das dieser über die TechNet Script Gallery zur Verfügung stellt:

https://gallery.technet.microsoft.com/Invoke-Generic-Methods-bf7675af/view/Discussions#content

Mir ist die Lösung etwas überdimensioniert. Für einfache Anforderungen ist sehr viel weniger formaler Aufwand erforderlich. Der Aufruf einer generischen Methode läuft darauf, dass man zuerst die Methode per GetMethods() als Objekt holt, daraus per MakeGenericMethod() eine generische Methode macht, die dann per Invoke() aufgerufen wird. Eine Parameterübergabe ist natürlich kein Problem.

Die folgenden zwei Functions stelle ich ohne weitere Erläuterungen vor.

Aufruf einer generischen Instanzenmethode

function Invoke-GenericMethod
{
    param([Object]$InputObject,
          [Type]$GenericType,
          [String]$MethodName,
          [Object]$ArgumentList)
    # Wichtig: Das Filterkriterium reicht eventuell nicht immer aus -
    # es darf immer nur eine generische Methode zurückgegeben werden!
    $Method = $InputObject.GetType().GetMethods() | Where-Object { $_.Name -eq $MethodName -and $_.IsGenericMethod -eq $true}
    $MethodCall = $Method.MakeGenericMethod($GenericType)
    $MethodCall.Invoke($InputObject, $ArgumentList)
}

Aufruf einer generischen statischen Methode

function Invoke-GenericMethod
{
    param([Type]$Type,
          [Type]$GenericType,
          [String]$MethodName,
          [Object]$ArgumentList)
    $Method = $Type.GetMethod($MethodName)
    $MethodCall = $Method.MakeGenericMethod($GenericType)
    $MethodCall.Invoke($null, $ArgumentList)
}

PowerPoint-Folien mit PowerShell in Text konvertieren

Dieser Beitrag ist etwas praxisorientierter. Zwei Dinge vorweg: Das Thema ist alles andere als nue und die vorgestellte Lösung ist alles andere als perfekt. Es geht ausschließlich darum, wie sich mit verhältnismäßig wenig Aufwand der Text aus den Folien einer PowerPoint-Datei per PowerShell extrahieren lässt. Sozusagen von Power zu Power (sollte ich im Folgenden einmal PowerShell mit PowerPoint verwechseln, bitte ich dies zu entschuldigen. Das passiert mir sogar in meinen Schulungen hin und wieder;).

Ausgangspunkt ist die Assembly DocumentFormat.OpenXml.dll, die Teil des Open XML SDKs von Microsoft ist. Es gibt sie in verschiedenen Varianten, sowohl für .NET 4.6 als auch für .NET Core. Ich verwende die Variante für .NET 4.6. Ich gebe mit Absicht keinen Download-Link an, da man sie an verschiedenden Stellen findet. Entwickler nutzen natürlich das Nuget-Package, das sich theoretisch auch per PowerShell und Install-Package hinzufügen lässt. Aus der Package-Datei (einfach ein .Zip anhängen) muss dann die Dll-Datei herauskopiert werden. Der Rest des Package kann gefahrlos „entsorgt“ werden.

Alle folgenden Beispiele gehen davon aus, dass sich die Dll-Datei im selben Verzeichnis befindet wie die Ps1-Datei.

Bevor es losgeht, noch ein Tipp. Der programm- bzw. skriptgesteuerte Umgang mit den „modernen“ Microsoft Office-Dokumentformaten ist sehr gut dokumentiert. Wie sich die Texte aus einer PowerPoint-Datei extrahieren lassen, z.B. unter der folgenden Adresse:

https://docs.microsoft.com/en-us/office/open-xml/how-to-get-all-the-text-in-all-slides-in-a-presentation

Die Beispiele sind natürlich alle in C# oder VB verfasst. Höchstwahrscheinlich gibt es bereits fertige PowerShell-Module für den Umgang mit PowerPoint-Präsentationen. Ich war zu bequem, um danach zu suchen. Im Folgenden geht es daher in erster Linie um das Ausprobieren mit dem Ziel, die Hintergründe besser verstehen zu können.

Schritt 1: Als erstes wird die Assembly per Add-Type geladen. Dabei kommt einmal mehr das sehr praktische using namespace zum Einsatz.

using&nbsp;namespace&nbsp;System.Text
using namespace DocumentFormat.OpenXml.Presentation
using namespace DocumentFormat.OpenXml.Packaging
 
$AssPfad = Join-Path -Path $PSScriptRoot -ChildPath "DocumentFormat.OpenXml.dll"
Add-Type -Path $AssPfad

Schritt 2: Im nächsten Schritt wird die Pptx-Datei geöffnet und das PresentationPart-Objekt angesprochen.

$PptxPfad = Join-Path -Path $PSScriptRoot -ChildPath "DiePräsentation.pptx"
$pptxDoc = [PresentationDocument]::Open($PptxPfad, $False)
$presentationPart = $pptxDoc.PresentationPart

Schritt 3: Ausgabe der Anzahl der Folien

Als kleine „Warm-Up“-Übung wird die Anzahl der Folien (Slides) ausgegeben.

$slideCount = @($presentationPart.SlideParts).Count
"Slide Count=$slideCount"

Hier tritt eine typische PowerShell-Besonderheit zum Tragen, über die ich auch nach > 16 Jahren PowerShell immer wieder „stolpere“. Ohne die explite Array-Klammerung per @() werden alle SlidePart-Objekte einzeln angesprochen und die Count-Eigenschaft liefert für jedes SlidePart-Objekt eine 1. Solche Besonderheiten findet man immer durch Ausprobieren heraus.

Schritt 4: Holen der SlideIds

Für das Durchlaufen aller Slides wird die SlideIdList und ihre ChildElements benötigt.

$slideIds = $presentationPart.Presentation.SlideIdList.ChildElements

Schritt 5: Durchlaufen aller Slides

Wir nähern uns dem Finale, wenngleich es noch ein Zwischenhügel erklommen werden muss. Abe die foreach-Schleife darf man bereits eingeben.

for($slideIndex = 1;$slideIndex -lt $slideCount;$slideIndex++)
{
 
 
}

Schritt 6: Holen des SlidePart

Jetzt wird es ein wenig komplizierter. Um an den Folieninhalt zu kommen, wird der SlidePart benötigt. Dazu wird die RelationShipId benötigt, um über diese über den allgemeinen PresentationPart den SlidePart zu holen.

$relId = ($slideIds[$slideIndex] -as [SlideId]).RelationshipId
$slide = ($presentationPart.GetPartById($relId) -as [SlidePart])

Schritt 7: Zusammenstellen des Textes des SlidePart

Liegt das SlidePart-Objekt vor, geht es „nur noch“ darum, den Text zu erhalten. Das SlidePart-Objekt besitzt, wie alle Inhaltsobjekte, eine praktische Descendants<T>-Methode, die alle Abkömmlinge des Knotens des angegebenen Typs holt. Da sich diese C#-Schreibweise aber nicht 1:1 übertragen lässt, kann die Methode daher nicht direkt aufgerufen werden.

Es gibt zwei Alternativen:

>Aufruf von Descendants() ohne Parameter. In diesem Fall werden alle Abkömmlinge zurückegeben. Die Text-Elemente werden dann per Where-Object gefilter.

>Aufruf der generischen Descendants<T>()-Methode mit Hilfe von etwas „Reflection-Magic“, die aber einfach und überschaubar ist (die Invoke-GenericMethod-Fuction stelle ich in einem anderen Blog-Beitrag vor).

Im Folgenden verwende ich die zweite Variante.

 
$slideText = [StringBuilder]::new()
$t = [DocumentFormat.OpenXml.Drawing.Text]
$TextDescendants = Invoke-GenericMethod -InputObject $slide.Slide -MethodName Descendants -GenericType $t 
foreach($Text in $TextDescendants)
{
   [void]$slideText.Append($Text.Text + "`n")
}
$slideText.toString()

Alle Textelemente eines Slide werden zu einem StringBuilder-Objekt hinzugefügt, dessen Inhalt am Ende ausgegeben wird. Warum einen StringBuilder und nicht einfach +=? Bei größeren Textmengen ist diese Variante deutlich schneller.

Der Vollständigheit halber stelle ich die Invoke-GenericMethod-Function ohne weiteren Erläuterungen vor. Nur soviel: Damit es nicht zu kompliziert wird, funktioniert der Methodenaufruf nur dann, dass die über die Abfrage von Name und IsGenericMethod tatsächlich nur die eine Methode resultiert, die auch aufgerufen werden soll.

Ansonsten deckt das Skript von Dave Wyatt alle Eventualitäten ab, ist dafür aber auch „etwas“ umfangreicher:

https://gallery.technet.microsoft.com/Invoke-Generic-Methods-bf7675af/view/Discussions#content

 
function Invoke-GenericMethod
{
    param([Object]$InputObject,
          [Type]$GenericType,
          [String]$MethodName,
          [Object]$ArgumentList)
    $Method = $InputObject.GetType().GetMethods() | Where-Object { $_.Name -eq $MethodName -and $_.IsGenericMethod -eq $true}
    $MethodCall = $Method.MakeGenericMethod($GenericType)
    $MethodCall.Invoke($InputObject, $ArgumentList)
}

Das war alles. Die vorgestellte Befehlsfolge sollte den Textinhalt einer beliebigen Pptx-Datei ausgeben.

PowerShell 7.0 ist verfügbar

Im PowerShell Team-Blog wurde es natürlich bereits angekündigt, auch Holger Schwichternberg hat bei Heise News ausführlich darüber geschrieben (https://www.heise.de/developer/meldung/PowerShell-7-0-freigegeben-Eine-Shell-fuer-fast-alle-und-fast-alles-4656825.html) , daher noch einmal der Form halber auch an dieser Stelle – seit Montag, dem 2. März 2020 ist die PowerShell 7.0 offiziell verfügbar.

Das ist insofern positiv, dass die neue Version deutlich macht, dass es mit der PowerShell weitergeht. Es gibt auch innovative Neuerungen, vor allem ist jetzt eine echte Parallelverarbeitung im Rahmen von ForEach-Object möglich. Erfreulich ist auch, dass unter Windows (fast?) alle Module der Windows PowerShell 5.1 zur Verfügung stehen.

Für den reinen Windows-Administrator bzw. für alle, die ausschließlich unter Windows arbeiten, gibt es aus meiner Sicht keinen Grund zu wechseln. Da die PowerShell ab Version 6 ohnehin als Anwendung installiert wird, ist es ohnehin keine Entweder-oder-Entscheidung. Windows PowerShell 5.1 und PowerShell 7 werden daher die nächsten Jahre ganz friedlich nebeneinander existieren.