Lic-MSBuild-Aufgabe ★Server

Die Aufgabe Lic liegt in Babel.Build.dll, derselben Assembly, die auch die Babel-Aufgabe des Obfuscators bereitstellt. Sie baut aus ihren Eigenschaften und Elementen eine Befehlszeile für lic auf und führt lic.exe aus. Damit steht alles, was die Referenz beschreibt, in einer Projektdatei zur Verfügung. Sie wird an zwei Stellen verwendet:

• In Ihren eigenen MSBuild-Projekten, zum Beispiel um eine Testlizenz für die zu testende Anwendung auszustellen oder um Kundenlizenzen auf einem Buildserver zu erzeugen.
• In Projektdateien .lcproj, die lic --makeproject aus einer Befehlszeile schreibt und lic --project erneut ausführt, siehe Projektdateien.

Die Aufgabe registrieren

Referenzieren Sie die Assembly der Aufgabe mit einem Element UsingTask, das auf Babel.Build.dll zeigt. In den Zip-Paketen von Babel liegt sie im Ordner MSBuild. Wenn BabelDir auf den Ordner gesetzt ist, in den babel_net472_<version>.zip entpackt wurde, lautet das Element:

<UsingTask TaskName="Lic" AssemblyFile="$(BabelDir)\MSBuild\Babel.Build.dll" />

Die Aufgabe führt lic.exe aus dem Ordner aus, den LicDirectory festlegt. Fehlt die Eigenschaft, sucht die Aufgabe neben Babel.Build.dll und danach in dem Ordner, den die Umgebungsvariable BABEL_INSTALL_DIRECTORY nennt. Weil lic.exe im Stammordner des entpackten Zip-Pakets liegt und nicht in dessen Ordner MSBuild, setzen Sie LicDirectory auf diesen Stammordner, wie es das folgende Beispiel tut.

Ein vollständiges Beispiel

Das folgende Projekt erzeugt nach dem Build eine signierte Lizenz für die erstellte Assembly. Lizenznehmer, Produkt, Funktionen, Felder und Einschränkungen sind MSBuild-Elemente, deren Metadaten zu den Paaren key=value der entsprechenden Schalter werden:

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <UsingTask TaskName="Lic" AssemblyFile="$(BabelDir)\MSBuild\Babel.Build.dll" />
 
  <PropertyGroup>
    <BabelDir>C:\Tools\babel_net472</BabelDir>
    <LicenseKeyFile>$(MSBuildProjectDirectory)\keys\signing.pem</LicenseKeyFile>
    <LicenseOutputFile>$(OutDir)MyApp.licenses</LicenseOutputFile>
  </PropertyGroup>
 
  <ItemGroup>
    <Licensee Include="Contoso">
      <Id>C-1001</Id>
      <Company>Contoso Ltd</Company>
      <Email>info@contoso.com</Email>
    </Licensee>
    <Product Include="MyApp">
      <Id>MYAPP</Id>
      <Version>2.1</Version>
      <Url>https://contoso.example</Url>
    </Product>
    <Feature Include="Pro">
      <Data>1</Data>
    </Feature>
    <Field Include="Seats">
      <Value>25</Value>
    </Field>
    <Restriction Include="Trial">
      <TrialDays>30</TrialDays>
      <RunInstances>2</RunInstances>
    </Restriction>
    <Restriction Include="Hardware">
      <HardwareKey>GPHI6-128DI-6196C-KN5LV-BCDRE</HardwareKey>
    </Restriction>
  </ItemGroup>
 
  <Target Name="MakeLicense" AfterTargets="Build">
    <Lic LicDirectory="$(BabelDir)"
         InputFile="$(TargetPath)"
         OutputFile="$(LicenseOutputFile)"
         KeyFile="$(LicenseKeyFile)"
         Sign="rsa"
         ExpireDate="365"
         Encoding="utf-8"
         Licensee="@(Licensee)"
         Product="@(Product)"
         Features="@(Feature)"
         Fields="@(Field)"
         Restrictions="@(Restriction)" />
  </Target>
</Project>

Das entspricht der Befehlszeile:

lic MyApp.dll --keyfile keys\signing.pem --sign rsa --expiredate 365 --encoding utf-8 --licensee name=Contoso --licensee id=C-1001 --licensee company="Contoso Ltd" --licensee email=info@contoso.com --product name=MyApp --product id=MYAPP --product version=2.1 --product url=https://contoso.example --feature def=... --field def=... --trial days=30 --trial instances=2 --hardware key=GPHI6-128DI-6196C-KN5LV-BCDRE --output MyApp.licenses

Setzen Sie ProvideCommandLineArgs="true" und lesen Sie das Ausgabeelement CommandLineArgs, um die genaue Befehlszeile zu sehen, die die Aufgabe aufgebaut hat.

Eigenschaften der Aufgabe

Jede Eigenschaft entspricht dem Schalter gleicher Bedeutung in der Referenz. Skalare Eigenschaften erwarten eine Zeichenfolge, Elementeigenschaften eine Elementliste.

Eingabe und Ausgabe

Schlüssel und Signatur

Inhalt der Lizenz

Einschränkungselemente

Der Wert Include eines Elements Restriction wählt den Schalter, ohne Beachtung der Groß- und Kleinschreibung, und die Metadaten liefern dessen Paare key=value. Jeder andere Wert von Include gilt als Name einer benutzerdefinierten Einschränkung und wird an --restriction übergeben, mit jedem Metadatum als Paar. Benutzerdefinierte Typen brauchen eine Erweiterungs-Assembly, die in Register aufgeführt ist.

Hardware-Identifikation

Tool und Diagnose

Projektdateien

Eine Datei .lcproj ist ein gewöhnliches MSBuild-Projekt, das die Aufgabe Lic registriert und sie aus einem Ziel MakeLicense aufruft, mit den Einstellungen einer einzelnen Lizenzerzeugung. lic --makeproject schreibt eine solche Datei aus den Schaltern der aktuellen Befehlszeile, neben die Ausgabedatei, sofern kein Name angegeben ist, und erzeugt die Lizenz trotzdem. lic --project liest eine solche Datei und führt sie aus, wobei weitere Schalter zusätzlich angewendet werden, ohne MSBuild aufzurufen. Die Datei lässt sich auch mit msbuild oder dotnet build auf einem Rechner erstellen, auf dem die Aufgabe registriert ist.

lic MyApp.dll --keyfile keys.pem --sign --licensee name=Contoso --expiredate 365 --output MyApp.licenses --makeproject MyApp.lcproj
lic --project MyApp.lcproj --licensee name="Fabrikam" --output Fabrikam.licenses

Die Projektdatei hält reproduzierbar fest, wie eine Lizenz entstanden ist, und gibt einer kundenspezifischen Erzeugung eine einzige Datei, die Sie versionieren, prüfen und erneut ausführen können.