Azure DevOps
Führen Sie Babel Obfuscator in Azure Pipelines aus, indem Sie das NuGet-Paket von Babel Obfuscator aus einem privaten Azure-Artifacts-Feed referenzieren und die Lizenz über Azure DevOps Secure Files bereitstellen.
Azure Pipelines erstellt das Projekt mit dem .NET SDK, und das Paket Babel.Obfuscator fügt die Babel-Aufgabe in diesen Build ein. Auf dem Agent muss Babel nicht installiert sein: Das Paket bringt die Buildtools mit, und die Pipeline muss sich nur bei dem Feed authentifizieren, der es hostet, und Babel eine Lizenz übergeben.
Das Beispiel auf dieser Seite ist eine kleine Konsolenanwendung:
git clone https://github.com/babelfornet/devops-integration.gitDas Paket in einem Azure-Artifacts-Feed hosten
Das Paket Babel.Obfuscator wird nicht auf nuget.org veröffentlicht. Sie erhalten es mit der Ultimate-Edition oder mit einer Standortedition von Babel Licensing. Laden Sie es in einen privaten Feed hoch, den nur Ihre Organisation lesen kann.
Laden Sie das Paket von Babel Obfuscator niemals in einen öffentlichen Feed hoch. Das Paket enthält die Buildtools von Babel, und eine erneute Veröffentlichung verstößt gegen die Bedingungen Ihrer Lizenz.
Öffnen Sie in Azure DevOps Artifacts, erstellen Sie einen Feed mit dem Namen Babel und laden Sie das Paket dorthin hoch:
dotnet nuget push Babel.Obfuscator.12.0.0.nupkg \
--source "https://pkgs.dev.azure.com/ORGANISATION/_packaging/Babel/nuget/v3/index.json" \
--api-key azLegen Sie neben der Projektmappe eine Datei NuGet.config an, damit sowohl Ihr Rechner als auch der Buildagent das Paket aus diesem Feed auflösen:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
<add key="babel" value="https://pkgs.dev.azure.com/ORGANISATION/_packaging/Babel/nuget/v3/index.json" />
</packageSources>
</configuration>Anmeldedaten fehlen in dieser Datei absichtlich. Auf einem Entwicklerrechner fragt der Azure Artifacts Credential Provider einmal danach. In der Pipeline liefert die Aufgabe NuGetAuthenticate das Token der Buildidentität. In beiden Fällen gelangt kein Geheimnis ins Repository.
Das Paket referenzieren
Fügen Sie die Paketreferenz jedem Projekt hinzu, dessen Assembly verschleiert werden soll:
<ItemGroup>
<PackageReference Include="Babel.Obfuscator" Version="12.0.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>PrivateAssets hält die Referenz aus den Paketen heraus, die Ihr Projekt erzeugt: Babel ist ein Tool für den Build und keine Abhängigkeit der ausgelieferten Assembly.
Die Lizenz zu Secure Files hinzufügen
Öffnen Sie Pipelines → Library → Secure files und laden Sie die signierte Datei babel.licenses hoch. Autorisieren Sie die Pipeline unter Pipeline permissions. Der Job lädt die Datei herunter und übergibt ihren Pfad an die MSBuild-Eigenschaft BabelLicense. Azure DevOps löscht die Kopie der Datei am Ende des Jobs.
Verwenden Sie mit Babel 12.3.0 den Dateipfad. Diese Version kann gültige XML-Lizenzen ablehnen, wenn sie über env:BABEL_LICENSE übergeben werden. Halten Sie das XML aus dem Repository, der Befehlszeile und den Werten der MSBuild-Eigenschaften heraus.
Die Pipeline
Die vollständige azure-pipelines.yml läuft auf einem Ubuntu-Agenten. Sie installiert das .NET SDK, authentifiziert sich beim Babel-Feed, stellt die Projektmappe wieder her, erstellt sie und veröffentlicht die verschleierte Ausgabe als Pipeline-Artefakt.
trigger:
- main
pool:
vmImage: ubuntu-latest
variables:
buildConfiguration: Release
steps:
- task: UseDotNet@2
displayName: Install the .NET SDK
inputs:
version: 10.0.x
- task: NuGetAuthenticate@1
displayName: Authenticate to the Babel feed
- script: dotnet restore DevOpsIntegration.sln
displayName: Restore
- task: DownloadSecureFile@1
name: babelLicense
displayName: Download the Babel license
inputs:
secureFile: 'babel.licenses'
- script: dotnet build DevOpsIntegration.sln --configuration $(buildConfiguration) --no-restore "-p:BabelLicense=$(babelLicense.secureFilePath)"
displayName: Build and obfuscate
- task: PublishPipelineArtifact@1
displayName: Publish the obfuscated output
inputs:
targetPath: DevOpsIntegration/bin/$(buildConfiguration)/net10.0
artifact: DevOpsIntegrationNuGetAuthenticate@1 macht den privaten Feed erreichbar. Die Aufgabe konfiguriert den Credential Provider mit der Identität der Pipeline selbst, sodass die Datei NuGet.config oben weder einen Abschnitt packageSourceCredentials noch ein Token von Ihnen braucht.
Wenn die Pipeline docker build ausführt, verwenden Sie den von DownloadSecureFile@1 gelieferten Pfad als Quelle für ein Docker-Secret.
Die Verschleierung läuft als Teil von dotnet build. Einen eigenen Babel-Schritt gibt es nicht. Das Babel-Protokoll erscheint in der Buildausgabe, und ein Lizenz- oder Konfigurationsfehler lässt den Schritt fehlschlagen.
Das Image des Agents muss nur das .NET SDK ausführen können. ubuntu-latest ist die günstigste Wahl und eignet sich für jede Ziellaufzeit, weil Babel auf IL-Code arbeitet: Ein Linux-Agent kann Assemblys verschleiern, die für Windows bestimmt sind. Verwenden Sie windows-latest, wenn der Build selbst Windows braucht, also bei Zielen für .NET Framework, WPF oder Windows Forms.
Die Verschleierung konfigurieren
Babel wird über MSBuild-Eigenschaften in der Projektdatei konfiguriert. Üblich ist, Debug-Builds unberührt zu lassen, damit sich das lokale Debuggen normal verhält, und Release-Builds zu schützen:
<PropertyGroup Condition="'$(Configuration)' == 'Debug'">
<BabelEnabled>false</BabelEnabled>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)' == 'Release'">
<StringEncryption>stream</StringEncryption>
<ControlFlowObfuscation>if=on;goto=on;switch=on;case=on;call=on</ControlFlowObfuscation>
<ControlFlowIterations>3</ControlFlowIterations>
<ResourceEncryption>true</ResourceEncryption>
</PropertyGroup>Alle Eigenschaften sind in der Referenz des Pakets aufgeführt, und Verschleierung konfigurieren erklärt, welchen Funktionen von Babel sie entsprechen.
Für alles, was feiner ist als ein Schalter für die ganze Assembly, fügen Sie eine Regeldatei hinzu. Die folgende Regel hält die Kontrollflussverschleierung von kurzen Methoden fern, bei denen die Abflachung mehr kostet, als sie verbirgt:
<?xml version="1.0" encoding="utf-8" ?>
<Rules>
<Rule name="reduce control flow" feature="control flow" exclude="false" applyToMembers="true">
<Target>Classes,Structures</Target>
<Pattern>*</Pattern>
<Properties>
<MaxSwitchTargets>5</MaxSwitchTargets>
<MinInstructionCount>18</MinInstructionCount>
<UseValueEncryption>false</UseValueEncryption>
</Properties>
<Description>Do not scramble methods with few instructions.</Description>
</Rule>
</Rules>Geben Sie dem Build die Datei mit der Eigenschaft BabelRules an:
<PropertyGroup>
<BabelRules>$(MSBuildThisFileDirectory)babelRules.xml</BabelRules>
</PropertyGroup>Das Ergebnis prüfen
Laden Sie das Pipelineartefakt herunter und prüfen Sie, ob die Assembly wirklich verschleiert ist, statt es nur anzunehmen. Das Beispiel Babel-Verschleierung erkennen zeigt, wie sich das automatisch testen lässt. Es lohnt sich, diese Prüfung als Kontrollpunkt in die Pipeline aufzunehmen: Sonst liefert eine falsch konfigurierte Lizenz oder ein übersprungener Buildschritt eine unverschleierte Assembly aus, ohne dass etwas fehlschlägt.
Bewahren Sie die vom Build erzeugte Map-Datei auf, wenn Sie Stacktraces aus der Produktion decodieren möchten. Siehe Stacktraces decodieren.