A WebJob-ready console application for renewing Azure Web App TLS/SSL certificates (based on letsencrypt-siteextension). Officially recommended by Microsoft for Web App Let's Encrypt integration.
HTTPS is the pervasive standard for all websites, regardless of size or field. The Mozilla foundation has gone so far as to announce their intent to completely phase out HTTP. Unfortunately, the procurement, maintenance, and renewal of SSL/TLS certificates has been an expensive and manual process for many.
Enter Let's Encrypt - a free, automated, and open Certificate Authority. Shortly after its release, Simon J.K. Pedersen created the excellent letsencrypt-siteextension Azure Web App extension for easy integration with Azure Web Apps. However, at the time of writing it suffers from several issues:
- The extension must be installed on the same web app as your site.
- This means you must install the extension on each and every Web App you own.
- Worse, if you happen to publish your Web App with the "Delete Existing files", it will silently delete the WebJob created by the extension, effectively nullifying it.
- There are no e-mail notifications (you could set some basic ones with Zapier but they won't contain details on the actual renewals that took place).
- It relies on an Azure Storage account which has to be configured in a certain way, which is an unneeded possible point of failure.
- The extension can only be run in the context of a web app. You might want to run it as a command-line tool (e.g. from your CI system).
letsencrypt-webapp-renewer is a WebJob-ready command-line executable that builds upon letsencrypt.azure.core (the core component behind letsencrypt-siteextension) to provide the following features:
- Install on any Web App (doesn't have to be the same web app for which you want to manage SSL certs).
- Multiple Web App management is supported.
- Publishing with "Delete Existing files" has no effect when the WebJob is deployed to a different (preferably dedicated) Web App.
- E-mail notifications are built in (via SendGrid).
- No external dependencies other than Let's Encrypt.
- Can be executed as a plain command-line tool from any environment.
Microsoft MVP Dixin Yan wrote an end-to-end guide for using letsencrypt-webapp-renewer which you can find here. Feel free to follow it for your convenience, but it is still recommended to read and understand the full documentation as detailed in the secionts below.
Create an AAD service principal with the proper permissions, as explained here and here. You can skip the parts about configuring the Azure Storage account and the site extension, but while you're there note down the parameters you'll need for the WebJob configuration below: SubscriptionId, TenantId, ResourceGroup, WebApp, ClientId, and ClientSecret.
The letsencrypt-webapp-renewer WebJob is configured via Web App Settings. You might as well configure it before installing so that it doesn't run with no/partial configuration by mistake. Note that these settings should be configured on the Web App where the letsencrypt-webapp-renewer WebJob is deployed (NOT on the Web Apps to be renewed). You can also use the configuration script to set/update these values.
- Set
letsencrypt:webAppsto a semicolon-delimited list of Azure Web App names for which certificate renewal should take place. - For each Web App specified in
letsencrypt:webApps, set the following app setting with the proper values as noted down in the preparation above (replacingwebAppNamewith the actual Web App name):letsencrypt:webAppName-subscriptionIdletsencrypt:webAppName-tenantIdletsencrypt:webAppName-resourceGroupletsencrypt:webAppName-hosts(semicolon-delimited)letsencrypt:webAppName-email(will be used for both Let's Encrypt registration and e-mail notifications)letsencrypt:webAppName-clientIdletsencrypt:webAppName-clientSecret(should be set as a connection string)letsencrypt:webAppName-servicePlanResourceGroup(optional, defaults to the Web App Resource Group)letsencrypt:webAppName-useIpBasedSsl(optional, defaults tofalse)letsencrypt:webAppName-rsaKeyLength(optional, defaults to2048)letsencrypt:webAppName-acmeBaseUri(optional, defaults tohttps://acme-v01.api.letsencrypt.org)letsencrypt:webAppName-webRootPath(optional, defaults to%HOME%\site\wwwrootor in case of running from package:%HOME%\site\letsencrypt)letsencrypt:webAppName-renewXNumberOfDaysBeforeExpiration(optional, defaults to-1which means renewal will take place regardless of the expiry time)
For more information about the various renewal settings see: https://github.com/sjkp/letsencrypt-siteextension.
letsencrypt:webApps:ohadsoft;howlongtobeatsteamletsencrypt:ohadsoft-subscriptionId:e432f869-4777-4380-a654-3440216992a2letsencrypt:ohadsoft-tenantId:ohadsoft.onmicrosoft.comletsencrypt:ohadsoft-resourceGroup:ohadsoft-rgletsencrypt:ohadsoft-hosts:www.ohadsoft.com;ohadsoft.comletsencrypt:ohadsoft-email:renewal@ohadsoft.comletsencrypt:ohadsoft-clientId:5e1346b6-7db5-4eae-b9fa-7b3d5e42e6c7- (connection string)
letsencrypt:ohadsoft-clientSecret:MySecretPassword123 letsencrypt:howlongtobeatsteam-subscriptionId:e432f869-4777-4380-a654-3440216992a2letsencrypt:howlongtobeatsteam-tenantId:ohadsoft.onmicrosoft.comletsencrypt:howlongtobeatsteam-resourceGroup:hltbs-rgletsencrypt:howlongtobeatsteam-hosts:www.howlongtobeatsteam.com;howlongtobeatsteam.comletsencrypt:howlongtobeatsteam-email:renewal@howlongtobeatsteam.comletsencrypt:howlongtobeatsteam-clientId:5e1346b6-7db5-4eae-b9fa-7b3d5e42e6c7- (connection string)
letsencrypt:howlongtobeatsteam-clientSecret:MySecretPassword123
The following settings are required in order to renew certificates on sovereign clouds:
letsencrypt:webAppName-azureAuthenticationEndpointletsencrypt:webAppName-azureTokenAudienceletsencrypt:webAppName-azureManagementEndpointletsencrypt:webAppName-azureDefaultWebSiteDomainName
You can run the Get-AzureEnvironment PowerShell cmdlet to get the required values. For more information about configuring sovereign clouds see: https://github.com/sjkp/letsencrypt-siteextension/wiki/Azure-Germany,-US-or-China.
In order to specify a Site Deployment Slot for a given web app, use the following syntax for the web app's name: webAppName{siteSlotName}. For example, if you have a foo site with no deployment slots and a bar site with staging and prod deployment slots, configure letsencrypt:webApps to be foo;bar{staging};bar{prod}. Different deployment slots are treated as different web apps and the normal setting rules apply, so you would still need to configure the regular settings for each of them (e.g. letsencrypt:foo-subscriptionId, letsencrypt:bar{staging}-subscriptionId, letsencrypt:bar{prod}-subscriptionId and so forth).
It is sometimes useful to share configuraiton settings beween web apps. For example, you might be using the same client credentials, the same subscription ID, or the same resource group for multiple web apps. In order to share a configuration setting between web apps, simply omit the webAppName- component of the configuration key. For example, in order to configure shared client credentials, set the letsencrypt:clientId app setting and letsencrypt:clientSecret connection string. These values will now be used by default for all configured web apps, unless explicitly overriden by setting the fully WebApp-qualified key name (by including the webAppName- component, e.g. letsencrypt:mySpecialSite-clientId).
All settings except hostsmay be shared.
If you have a site that supports many domain names, it can be useful to group them into separate certificates. In order to handle renewing multiple certificates associated with a single site, use the following syntax for the web app's name: webAppName[groupName] or webAppName{siteSlotName}[groupName]. For example, if you have a foo site that has two certificates that need to be updated, configure letsencrypt:webApps to be foo;foo[Group2]. You would still need to configure the regular settings for each of them (e.g. letsencrypt:foo-subscriptionId, letsencrypt:foo[Group2]-subscriptionId and so forth).
There is a PowerShell configuration-script Set-LetsEncryptConfiguration.ps1 which can be used to streamline the configuration of multiple Web Apps. Running the script is straightfoward, and further documentation resides inside it.
- (optional but highly recommended) Create a new dedicated Web App for cert renewal, to which you will deploy the
letsencrypt-webapp-renewerWebJob. This will drastically decrease the likelihood of accidental deletion of the renewal WebJob (e.g. upon deployment of a different app to the same Web App using Delete Existing files) - Download the latest
letsencrypt-webapp-renewerWebJob zip file. - Deploy the WebJob zip file you downloaded above to the Web App where you want cert renewal to execute using one of the following scheduling methods:
- CRON based is simple to set up but REQUIRES YOUR CERT RENEWAL WEB APP (THE ONE WHERE THE
letsencrypt-webapp-renewerWEBJOB WILL BE RUNNING) TO BE CONFIGURED AS "ALWAYS ON". Note that asettings.jobfile as described in the docs is unnecessary - when you upload the WebJob in the portal simply select Triggered in the Type field and Scheduled in the Triggers field to be given an option to specify a CRON expression. The recommended Let's Encrypt renewal period is 60 days, so you could use a CRON expression that fires once every two months, for example:0 0 0 1 1,3,5,7,9,11 *. - Azure Function based is a good option if your App Service plan does not support Always On (Free or Shared).
- Azure Scheduler based is slightly more complex to set up but does not require your site to be configured as Always On. Note that the instructions in the link mostly explain the process for the old (classic) Azure portal, but it's pretty easy to do the same in the new one (portal.azure.com). At the time of writing, there is no free Azure Scheulder plan.
- CRON based is simple to set up but REQUIRES YOUR CERT RENEWAL WEB APP (THE ONE WHERE THE
The following are optional but highly recommended.
- In order to receive notifications on successful renewals, set the
letsencrypt:SendGridApiKeyconnection string to your SendGrid API key. At the time of writing, SendGrid offer a free plan in the Azure Marketplace which should easily suffice for any reasonable SSL renewal notification needs. - Set up Zapier to send you notifications on
letsencrypt-webapp-renewerWebJob runs. While e-mail notifications are supported as described above, they will only be fired when the WebJob has failed for any reason (this is intentional - a WebJob cannot reliably handle any possible failure it might encounter). By contrast, Zapier operates externally to the WebJob and should be able to report any error that might have caused the WebJob to fail. At the time of writing, Zapier offer a free account which should easily suffice for any reasonable SSL renewal notification needs.
Test the WebJob by triggering it manually. You should see a new certificate served when you visit your site.
When executed outside of a WebJob context (as determined by the WEBJOBS_NAME environment variable), the WebJob executable (AzureLetsEncryptRenewer.exe) functions as a standalone command-line tool with the following options:
| Flag | Details |
|---|---|
| -s, --subscriptionId | Required. Subscription ID |
| -t, --tenantId | Required. Tenant ID |
| -r, --resourceGroup | Required. Resource Group |
| -w, --webApp | Required. Web App |
| -o, --hosts | Required. Semicolon-delimited list of hosts to include in the certificate - the first will comprise the Subject Name SN) and the rest will comprise the Subject Alternative Names (SANs) |
| -e, --email | Required. E-mail for Let's Encrypt registration and expiry notifications |
| -c, --clientId | Required. Client ID |
| -l, --clientSecret | Required. Client Secret |
| -p, --servicePlanResourceGroup | Service Plan Resource Group (if not specified, the provided Web App resource group will be used) |
| -d, --siteSlotName | Site Deployment Slot |
| -i, --useIpBasedSsl | (Default: false) Use IP Based SSL |
| -k, --rsaKeyLength | (Default: 2048) Certificate RSA key length |
| -a, --acmeBaseUri | ACME base URI, defaults to: https://acme-v01.api.letsencrypt.org/ |
| -n, --renewXNumberOfDaysBeforeExpiration | (Default: -1) Number of days before certificate expiry to renew, defaults to a negative value meaning renewal will ake place regardless of the expiry time |
| -h, --azureAuthenticationEndpoint | The Active Directory Authority, defaults to: https://login.windows.net/ |
| -u, --azureTokenAudience | The Active Directory Service Endpoint Resource ID, defaults to: https://management.core.windows.net/ |
| -m, --azureManagementEndpoint | The Resource Manager URL, defaults to: https://management.azure.com |
| -b, --azureDefaultWebSiteDomainName | The Azure Web Sites default domain name, defaults to: azurewebsites.net |
| --help | Display this help screen. |
| --version | Display version information. |
- 0 - Success
- 1 - Bad argument(s)
- 2 - Unexpected error
letsencrypt-webapp-renewer gathers anonymous telemetry for usage analysis and error reporting. You can disable it by setting the LETSENCRYPT_DISABLE_TELEMETRY environment variable to any non-empty value.
Since this project relies on https://github.com/sjkp/letsencrypt-siteextension, some of its limitations apply as well:
This site-extension is NOT supported by Microsoft it is my own work based on https://github.com/ebekker/ACMESharp and https://github.com/Lone-Coder/letsencrypt-win-simple - this means don't expect 24x7 support, I use it for several of my own smaller sites, but if you are running sites that are important you should consider spending the few $ on a certificate and go with a Microsoft supported way of enabling SSL, so you have someone to blame :)
Note that Let's Encrypt works by providing automated certificates of a short (currently three month) duration. This extension is BETA SOFTWARE. You will need to keep this extension updated or risk losing SSL access when your certificate expires.
Due to rate limiting of Let's Encrypt servers, you can only request five certificates per domain name per week. Configuration errors or errors in this site extension may render you unable to retrieve a new certificate for seven days. If up-time is critical, have a plan for deploying a SSL certificate from another source in place.
No support for multi-region web apps, so if you use traffic manager or some other load balancer to route traffic between web apps in different regions please don't use this extension.
The site-extension will not work with Azure App Service Local Cache
Please take note that this Site-Extension is beta-software, so use at your own risk.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYLEFT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Consult the Let's Encrypt documentation for rate limits: https://letsencrypt.org/docs/rate-limits/
