The Software Entitlement Service of Azure Batch allows a software package to verify it is running in an environment where usage metering takes place. This SDK provides tooling and documentation to support software vendors integrating with the service.
The SDK includes the following:
-
Software entitlement library code for integration into applications. The interface is native C++ and is provided as source code ready for use.
-
A command line utility (sestest) is provided to assist with testing of the integration. This utility supports token generation and can emulate a software entitlement server for testing outside of the Batch environment.
-
A command line client (sesclient) to demonstrate use of the software entitlement token and the library code.
-
Reference documentation on the REST API, detailing the interaction between the library code used by the software application and the software entitlement server.
-
A guide to compilation for getting the supplied source ready for use.
-
A full walk-through to take new partners through the end to end process of compilation and use.
-
A repository guide that identifies key documents, folders, scripts and classes for developers working with the code.
-
Release notes that detail the changes between releases.
Azure Batch will provide two environment variables (1) for consumption by a metered software package - a software entitlement token and a URL for a software entitlement server for verification of that token. The software package will retrieve both environment variables (2) and securely contact the appropriate server requesting an entitlement to execute (3). The Software Entitlement Server will check the entitlement for the software package (4) and respond with either Approved or Denied (5).
The Batch service provides two pieces of information to a metered software application through environment variables:
| Variable | Definition |
|---|---|
AZ_BATCH_ACCOUNT_URL |
The URL of an endpoint for the batch service account. Sample: https://demo.westus.batch.azure.com |
AZ_BATCH_SOFTWARE_ENTITLEMENT_TOKEN |
An encoded string containing the actual software entitlement token. |
The software package will check that the provided batch account endpoint specifies a known host (such as *.batch.azure.com or one of the equivalents for national clouds); if it does not, the software package should not consider itself entitled. If the endpoint is known, the software application will request a software entitlement from the specified server over a secured HTTPS/TLS connection.
The software package is not expected to decrypt or otherwise process the software entitlement token aside from passing it to the Software Entitlement Service for verification.
The software entitlement token will be an encrypted and signed JWT token containing information about the virtual machine, the task and the permitted software packages.
The software application will authenticate the software entitlement server by only contacting known hosts and by pinning the HTTPS/TLS connection to a certificate chain known to be issued by Microsoft Azure.
The software entitlement server will authenticate the software package by comparing the request with details found inside the encrypted and signed entitlement token, including the application id, network address, and current time.
The sestest command line application and associated assemblies are written in C#7 and require version 1.1 or higher of .NET Core to be pre-installed. The tool was written with Visual Studio 2017; it should compile with just the .NET Core SDK installation.
The C++ source for the client library requires libcurl and OpenSSL libraries as packaged by vcpkg. The library was also written with Visual Studio 2017; it should compile with any modern C++ compiler.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.