This article describes how to add authentication for a Digital Ocean account to an Azure AD B2C custom policy.
Architecture
The following diagram illustrates the authentication flow for a Digital Ocean account to an Azure AD B2C custom policy.
The authentication flow requires an Azure function that retrieves claims for the authenticated user.
For information about Digital Ocean and OAuth 2.0, see https://docs.digitalocean.com/reference/api/oauth-api/.
Prerequisites
- If you don’t already have one, then you must create an Azure AD B2C tenant that is linked to your Azure subscription.
- Prepare your Azure AD B2C tenant by creating the token signing and encryption keys and creating the Identity Experience Framework applications.
- Download one of the starter packs for Azure AD B2C from Microsoft’s GitHub repository.
Create the Azure function
- Create a C# function containing the following code. This implements a GetDigitalOceanClaims function that retrieves flattened claims for the authenticated user. Then publish this C# function to a function app.
using System;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using System.Web.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Extensions.Logging;
namespace SignInWithDigitalOcean
{
public static class GetDigitalOceanClaims
{
private static readonly HttpClient InnerClient = new HttpClient();
[FunctionName("GetDigitalOceanClaims")]
public static async Task<IActionResult> Run(
[HttpTrigger(AuthorizationLevel.Anonymous, "get")] HttpRequest request,
ILogger logger)
{
if (!request.Headers.TryGetValue("Authorization", out var authorizationHeaderValues))
{
logger.LogError("The Authorization header is missing");
return new BadRequestResult();
}
if (authorizationHeaderValues.Count > 1)
{
logger.LogError("The Authorization header is invalid");
return new BadRequestResult();
}
var authorizationHeaderValue = authorizationHeaderValues[0];
var authorizationHeaderValueParts = authorizationHeaderValue.Split(' ');
if (authorizationHeaderValueParts.Length != 2 || !authorizationHeaderValueParts[0].Equals("Bearer", StringComparison.OrdinalIgnoreCase))
{
logger.LogError("The Authorization header is invalid");
return new BadRequestResult();
}
var innerRequest = new HttpRequestMessage(HttpMethod.Get, "https://api.digitalocean.com/v2/account");
innerRequest.Headers.Authorization = new AuthenticationHeaderValue(authorizationHeaderValueParts[0], authorizationHeaderValueParts[1]);
var innerResponse = await InnerClient.SendAsync(innerRequest);
if (innerResponse.StatusCode != HttpStatusCode.OK)
{
return new InternalServerErrorResult();
}
var innerResponseModel = await innerResponse.Content.ReadAsJsonAsync<DigitalOceanClaimsResponseModel>();
var responseModel = new
{
id = innerResponseModel.Account.Uuid,
email = innerResponseModel.Account.Email
};
return new OkObjectResult(responseModel);
}
}
}
The model classes are implemented as follows.
using Newtonsoft.Json;
namespace SignInWithDigitalOcean
{
public class DigitalOceanClaimsResponseModel
{
[JsonProperty("account")]
public DigitalOceanAccountModel Account { get; set; }
}
public class DigitalOceanAccountModel
{
[JsonProperty("uuid")]
public string Uuid { get; set; }
[JsonProperty("email")]
public string Email { get; set; }
}
}
The ReadAsJsonAsync extension method is implemented as follows.
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;
namespace SignInWithDigitalOcean
{
public static class HttpContentExtensions
{
public static async Task<T> ReadAsJsonAsync<T>(this HttpContent content)
{
if (content == null)
{
return default;
}
var value = await content.ReadAsStringAsync();
return JsonConvert.DeserializeObject<T>(value);
}
}
}
Configure a Digital Ocean application
- Log in to https://cloud.digitalocean.com/account/api.
- On the Applications & API page, select OAuth Applications and then select Register OAuth Application.
- In the Register a new OAuth application dialogue, enter the following fields and then select Register OAuth Application:
- Name
- Homepage URL
- Description
- Callback URL: Enter either https://your-tenant-name.b2clogin.com/your-tenant-name.onmicrosoft.com/oauth2/authresp if you use the built-in domain or https://your-domain-name/your-tenant-name.onmicrosoft.com/oauth2/authresp if you use a custom domain for the Callback URL field. Replace your-tenant-name with your tenant name and your-domain-name with your custom domain.
- On the Applications & API page, in the OAuth Applications tab, select More for the new application and then select View.
- On the OAuth Application Details page, copy the Client ID and Client Secret fields.
Add the client secret for the Digital Ocean application as a policy key
- Sign in to the Azure AD B2C portal.
- Select Identity Experience Framework.
- Select Policy keys.
- Select Add.
- In the Create a key section, enter the following fields and then select Create:
- Options:
Manual - Name:
DigitalOceanClientSecret - Secret: Paste the Client Secret field that was copied in the previous section.
- Options:
Configure Digital Ocean as an identity provider
- Open the TrustFrameworkExtensions.xml file.
- Find the ClaimsProviders element. If it doesn’t exist, then add it to the TrustFrameworkPolicy element.
- Add the following ClaimsProvider element to the ClaimsProviders element. Replace
your-digital-ocean-client-idwith the Client ID field that was copied in the Configure a Digital Ocean application section. Replaceyour-function-app-namewith the function app name that was created in the Create the Azure function section.
<ClaimsProvider>
<Domain>digitalocean.com</Domain>
<DisplayName>Digital Ocean</DisplayName>
<TechnicalProfiles>
<TechnicalProfile Id="DigitalOcean-OAuth2">
<DisplayName>Digital Ocean</DisplayName>
<Protocol Name="OAuth2" />
<Metadata>
<Item Key="client_id">your-digital-ocean-client-id</Item>
<Item Key="authorization_endpoint">https://cloud.digitalocean.com/v1/oauth/authorize</Item>
<Item Key="AccessTokenEndpoint">https://cloud.digitalocean.com/v1/oauth/token</Item>
<Item Key="ClaimsEndpoint">https://your-function-app-name.azurewebsites.net/api/GetDigitalOceanClaims</Item>
<Item Key="HttpBinding">POST</Item>
<Item Key="BearerTokenTransmissionMethod">AuthorizationHeader</Item>
<Item Key="UsePolicyInRedirectUri">false</Item>
</Metadata>
<CryptographicKeys>
<Key Id="client_secret" StorageReferenceId="B2C_1A_DigitalOceanClientSecret" />
</CryptographicKeys>
<OutputClaims>
<OutputClaim ClaimTypeReferenceId="authenticationSource" DefaultValue="socialIdpAuthentication" AlwaysUseDefaultValue="true" />
<OutputClaim ClaimTypeReferenceId="identityProvider" DefaultValue="digitalocean.com" AlwaysUseDefaultValue="true" />
<OutputClaim ClaimTypeReferenceId="issuerUserId" PartnerClaimType="id" />
<OutputClaim ClaimTypeReferenceId="email" PartnerClaimType="email" />
</OutputClaims>
<OutputClaimsTransformations>
<OutputClaimsTransformation ReferenceId="CreateRandomUPNUserName" />
<OutputClaimsTransformation ReferenceId="CreateUserPrincipalName" />
<OutputClaimsTransformation ReferenceId="CreateAlternativeSecurityId" />
</OutputClaimsTransformations>
<UseTechnicalProfileForSessionManagement ReferenceId="SM-SocialLogin" />
</TechnicalProfile>
</TechnicalProfiles>
</ClaimsProvider>
Add a user journey
- Open the TrustFrameworkBase.xml file.
- Copy the UserJourney element that includes
Id="SignUpOrSignIn". - Open the TrustFrameworkExtensions.xml file and find the UserJourneys element. If it doesn’t exist, then add it to the TrustFrameworkPolicy element.
- Paste the UserJourney element that was copied in step 2 to the UserJourneys element and replace the Id attribute for this UserJourney element from
"SignUpOrSignIn"to"DigitalOceanSignUpOrSignIn".
Add the identity provider to the user journey
- Add the claims provider that was configured in the Configure Digital Ocean as an identity provider section to the user journey that was added in the previous section.
<OrchestrationStep Order="1" Type="CombinedSignInAndSignUp" ContentDefinitionReferenceId="api.signuporsignin">
<ClaimsProviderSelections>
...
<ClaimsProviderSelection TargetClaimsExchangeId="DigitalOceanExchange" />
</ClaimsProviderSelections>
...
</OrchestrationStep>
<OrchestrationStep Order="2" Type="ClaimsExchange">
...
<ClaimsExchanges>
<ClaimsExchange Id="DigitalOceanExchange" TechnicalProfileReferenceId="DigitalOcean-OAuth2" />
</ClaimsExchanges>
...
</OrchestrationStep>
Configure the relying party policy
- Open the SignUpOrSignIn.xml file.
- Replace the ReferenceId attribute for the DefaultUserJourney element from
"SignUpOrSignIn"to".DigitalOceanSignUpOrSignIn"
<RelyingParty>
<DefaultUserJourney ReferenceId="DigitalOceanSignUpSignIn" />
...
</RelyingParty>
Upload and test the custom policy
- Upload all policy files in the following order to your Azure AD B2C tenant:
- TrustFrameworkBase.xml
- TrustFrameworkLocalization.xml
- TrustFrameworkExtensions.xml
- SignUpOrSignIn.xml
- Test the B2C_1A_signup_signin policy from your Azure AD B2C tenant.
