-
Notifications
You must be signed in to change notification settings - Fork 541
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement Pipedrive OAuth provider (#892)
Implement Pipedrive OAuth provider.
- Loading branch information
1 parent
22fe33a
commit 3be27ad
Showing
9 changed files
with
307 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
src/AspNet.Security.OAuth.Pipedrive/AspNet.Security.OAuth.Pipedrive.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFrameworks>$(DefaultNetCoreTargetFramework)</TargetFrameworks> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- TODO Enable once this provider is published to NuGet.org --> | ||
| <PropertyGroup> | ||
| <DisablePackageBaselineValidation>true</DisablePackageBaselineValidation> | ||
| <PackageValidationBaselineVersion>8.0.1</PackageValidationBaselineVersion> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup> | ||
| <Description>ASP.NET Core security middleware enabling Pipedrive authentication.</Description> | ||
| <Authors>Denys Goncharenko</Authors> | ||
| <PackageTags>aspnetcore;authentication;oauth;pipedrive;security</PackageTags> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <FrameworkReference Include="Microsoft.AspNetCore.App" /> | ||
| <PackageReference Include="JetBrains.Annotations" PrivateAssets="All" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
48 changes: 48 additions & 0 deletions
48
src/AspNet.Security.OAuth.Pipedrive/PipedriveAuthenticationDefaults.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| * See https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers | ||
| * for more information concerning the license and the contributors participating to this project. | ||
| */ | ||
|
|
||
| namespace AspNet.Security.OAuth.Pipedrive; | ||
|
|
||
| /// <summary> | ||
| /// Default values used by the Pipedrive authentication middleware. | ||
| /// </summary> | ||
| public static class PipedriveAuthenticationDefaults | ||
| { | ||
| /// <summary> | ||
| /// Default value for <see cref="AuthenticationScheme.Name"/>. | ||
| /// </summary> | ||
| public const string AuthenticationScheme = "Pipedrive"; | ||
|
|
||
| /// <summary> | ||
| /// Default value for <see cref="AuthenticationScheme.DisplayName"/>. | ||
| /// </summary> | ||
| public static readonly string DisplayName = "Pipedrive"; | ||
|
|
||
| /// <summary> | ||
| /// Default value for <see cref="AuthenticationSchemeOptions.ClaimsIssuer"/>. | ||
| /// </summary> | ||
| public static readonly string Issuer = "Pipedrive"; | ||
|
|
||
| /// <summary> | ||
| /// Default value for <see cref="RemoteAuthenticationOptions.CallbackPath"/>. | ||
| /// </summary> | ||
| public static readonly string CallbackPath = "/signin-pipedrive"; | ||
|
|
||
| /// <summary> | ||
| /// Default value for <see cref="OAuthOptions.AuthorizationEndpoint"/>. | ||
| /// </summary> | ||
| public static readonly string AuthorizationEndpoint = "https://oauth.pipedrive.com/oauth/authorize"; | ||
|
|
||
| /// <summary> | ||
| /// Default value for <see cref="OAuthOptions.TokenEndpoint"/>. | ||
| /// </summary> | ||
| public static readonly string TokenEndpoint = "https://oauth.pipedrive.com/oauth/token"; | ||
|
|
||
| /// <summary> | ||
| /// Default value for <see cref="OAuthOptions.UserInformationEndpoint"/>. | ||
| /// </summary> | ||
| public static readonly string UserInformationEndpoint = "https://api.pipedrive.com/v1/users/me"; | ||
| } |
74 changes: 74 additions & 0 deletions
74
src/AspNet.Security.OAuth.Pipedrive/PipedriveAuthenticationExtensions.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| * See https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers | ||
| * for more information concerning the license and the contributors participating to this project. | ||
| */ | ||
|
|
||
| using Microsoft.Extensions.DependencyInjection; | ||
|
|
||
| namespace AspNet.Security.OAuth.Pipedrive; | ||
|
|
||
| /// <summary> | ||
| /// Extension methods to add Pipedrive authentication capabilities to an HTTP application pipeline. | ||
| /// </summary> | ||
| public static class PipedriveAuthenticationExtensions | ||
| { | ||
| /// <summary> | ||
| /// Adds <see cref="PipedriveAuthenticationHandler"/> to the specified | ||
| /// <see cref="AuthenticationBuilder"/>, which enables Pipedrive authentication capabilities. | ||
| /// </summary> | ||
| /// <param name="builder">The authentication builder.</param> | ||
| /// <returns>A reference to this instance after the operation has completed.</returns> | ||
| public static AuthenticationBuilder AddPipedrive([NotNull] this AuthenticationBuilder builder) | ||
| { | ||
| return builder.AddPipedrive(PipedriveAuthenticationDefaults.AuthenticationScheme, options => { }); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds <see cref="PipedriveAuthenticationHandler"/> to the specified | ||
| /// <see cref="AuthenticationBuilder"/>, which enables Pipedrive authentication capabilities. | ||
| /// </summary> | ||
| /// <param name="builder">The authentication builder.</param> | ||
| /// <param name="configuration">The delegate used to configure the OpenID 2.0 options.</param> | ||
| /// <returns>A reference to this instance after the operation has completed.</returns> | ||
| public static AuthenticationBuilder AddPipedrive( | ||
| [NotNull] this AuthenticationBuilder builder, | ||
| [NotNull] Action<PipedriveAuthenticationOptions> configuration) | ||
| { | ||
| return builder.AddPipedrive(PipedriveAuthenticationDefaults.AuthenticationScheme, configuration); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds <see cref="PipedriveAuthenticationHandler"/> to the specified | ||
| /// <see cref="AuthenticationBuilder"/>, which enables Pipedrive authentication capabilities. | ||
| /// </summary> | ||
| /// <param name="builder">The authentication builder.</param> | ||
| /// <param name="scheme">The authentication scheme associated with this instance.</param> | ||
| /// <param name="configuration">The delegate used to configure the Pipedrive options.</param> | ||
| /// <returns>The <see cref="AuthenticationBuilder"/>.</returns> | ||
| public static AuthenticationBuilder AddPipedrive( | ||
| [NotNull] this AuthenticationBuilder builder, | ||
| [NotNull] string scheme, | ||
| [NotNull] Action<PipedriveAuthenticationOptions> configuration) | ||
| { | ||
| return builder.AddPipedrive(scheme, PipedriveAuthenticationDefaults.DisplayName, configuration); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds <see cref="PipedriveAuthenticationHandler"/> to the specified | ||
| /// <see cref="AuthenticationBuilder"/>, which enables Pipedrive authentication capabilities. | ||
| /// </summary> | ||
| /// <param name="builder">The authentication builder.</param> | ||
| /// <param name="scheme">The authentication scheme associated with this instance.</param> | ||
| /// <param name="caption">The optional display name associated with this instance.</param> | ||
| /// <param name="configuration">The delegate used to configure the Pipedrive options.</param> | ||
| /// <returns>The <see cref="AuthenticationBuilder"/>.</returns> | ||
| public static AuthenticationBuilder AddPipedrive( | ||
| [NotNull] this AuthenticationBuilder builder, | ||
| [NotNull] string scheme, | ||
| [CanBeNull] string caption, | ||
| [NotNull] Action<PipedriveAuthenticationOptions> configuration) | ||
| { | ||
| return builder.AddOAuth<PipedriveAuthenticationOptions, PipedriveAuthenticationHandler>(scheme, caption, configuration); | ||
| } | ||
| } |
70 changes: 70 additions & 0 deletions
70
src/AspNet.Security.OAuth.Pipedrive/PipedriveAuthenticationHandler.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| * See https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers | ||
| * for more information concerning the license and the contributors participating to this project. | ||
| */ | ||
|
|
||
| using System.Net.Http.Headers; | ||
| using System.Security.Claims; | ||
| using System.Text.Encodings.Web; | ||
| using System.Text.Json; | ||
| using Microsoft.Extensions.Logging; | ||
| using Microsoft.Extensions.Options; | ||
|
|
||
| namespace AspNet.Security.OAuth.Pipedrive; | ||
|
|
||
| public partial class PipedriveAuthenticationHandler : OAuthHandler<PipedriveAuthenticationOptions> | ||
| { | ||
| public PipedriveAuthenticationHandler( | ||
| [NotNull] IOptionsMonitor<PipedriveAuthenticationOptions> options, | ||
| [NotNull] ILoggerFactory logger, | ||
| [NotNull] UrlEncoder encoder) | ||
| : base(options, logger, encoder) | ||
| { | ||
| } | ||
|
|
||
| protected override async Task<AuthenticationTicket> CreateTicketAsync( | ||
| [NotNull] ClaimsIdentity identity, | ||
| [NotNull] AuthenticationProperties properties, | ||
| [NotNull] OAuthTokenResponse tokens) | ||
| { | ||
| using var request = new HttpRequestMessage(HttpMethod.Get, Options.UserInformationEndpoint); | ||
| request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); | ||
| request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokens.AccessToken); | ||
|
|
||
| using var response = await Backchannel.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, Context.RequestAborted); | ||
| if (!response.IsSuccessStatusCode) | ||
| { | ||
| await Log.UserProfileErrorAsync(Logger, response, Context.RequestAborted); | ||
| throw new HttpRequestException("An error occurred while retrieving the user profile."); | ||
| } | ||
|
|
||
| using var payload = JsonDocument.Parse(await response.Content.ReadAsStringAsync(Context.RequestAborted)); | ||
|
|
||
| var principal = new ClaimsPrincipal(identity); | ||
| var context = new OAuthCreatingTicketContext(principal, properties, Context, Scheme, Options, Backchannel, tokens, payload.RootElement); | ||
| context.RunClaimActions(); | ||
|
|
||
| await Events.CreatingTicket(context); | ||
| return new AuthenticationTicket(context.Principal!, context.Properties, Scheme.Name); | ||
| } | ||
|
|
||
| private static partial class Log | ||
| { | ||
| internal static async Task UserProfileErrorAsync(ILogger logger, HttpResponseMessage response, CancellationToken cancellationToken) | ||
| { | ||
| UserProfileError( | ||
| logger, | ||
| response.StatusCode, | ||
| response.Headers.ToString(), | ||
| await response.Content.ReadAsStringAsync(cancellationToken)); | ||
| } | ||
|
|
||
| [LoggerMessage(1, LogLevel.Error, "An error occurred while retrieving the user profile: the remote server returned a {Status} response with the following payload: {Headers} {Body}.")] | ||
| private static partial void UserProfileError( | ||
| ILogger logger, | ||
| System.Net.HttpStatusCode status, | ||
| string headers, | ||
| string body); | ||
| } | ||
| } |
31 changes: 31 additions & 0 deletions
31
src/AspNet.Security.OAuth.Pipedrive/PipedriveAuthenticationOptions.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| * See https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers | ||
| * for more information concerning the license and the contributors participating to this project. | ||
| */ | ||
|
|
||
| using System.Security.Claims; | ||
|
|
||
| namespace AspNet.Security.OAuth.Pipedrive; | ||
|
|
||
| /// <summary> | ||
| /// Defines a set of options used by <see cref="PipedriveAuthenticationHandler"/>. | ||
| /// </summary> | ||
| public class PipedriveAuthenticationOptions : OAuthOptions | ||
| { | ||
| public PipedriveAuthenticationOptions() | ||
| { | ||
| ClaimsIssuer = PipedriveAuthenticationDefaults.Issuer; | ||
| CallbackPath = PipedriveAuthenticationDefaults.CallbackPath; | ||
|
|
||
| AuthorizationEndpoint = PipedriveAuthenticationDefaults.AuthorizationEndpoint; | ||
| TokenEndpoint = PipedriveAuthenticationDefaults.TokenEndpoint; | ||
| UserInformationEndpoint = PipedriveAuthenticationDefaults.UserInformationEndpoint; | ||
|
|
||
| Scope.Add("base"); | ||
|
|
||
| ClaimActions.MapCustomJson(ClaimTypes.NameIdentifier, user => user.GetProperty("data").GetString("id")); | ||
| ClaimActions.MapCustomJson(ClaimTypes.Name, user => user.GetProperty("data").GetString("name")); | ||
| ClaimActions.MapCustomJson(ClaimTypes.Email, user => user.GetProperty("data").GetString("email")); | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
test/AspNet.Security.OAuth.Providers.Tests/Pipedrive/PipedriveTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| * See https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers | ||
| * for more information concerning the license and the contributors participating to this project. | ||
| */ | ||
|
|
||
| namespace AspNet.Security.OAuth.Pipedrive; | ||
|
|
||
| public class PipedriveTests(ITestOutputHelper outputHelper) : OAuthTests<PipedriveAuthenticationOptions>(outputHelper) | ||
| { | ||
| public override string DefaultScheme => PipedriveAuthenticationDefaults.AuthenticationScheme; | ||
|
|
||
| protected internal override void RegisterAuthentication(AuthenticationBuilder builder) | ||
| { | ||
| builder.AddPipedrive(options => ConfigureDefaults(builder, options)); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(ClaimTypes.NameIdentifier, "12345")] | ||
| [InlineData(ClaimTypes.Name, "Test User")] | ||
| [InlineData(ClaimTypes.Email, "testuser@example.com")] | ||
| public async Task Can_Sign_In_Using_Pipedrive(string claimType, string claimValue) | ||
| => await AuthenticateUserAndAssertClaimValue(claimType, claimValue); | ||
| } |
28 changes: 28 additions & 0 deletions
28
test/AspNet.Security.OAuth.Providers.Tests/Pipedrive/bundle.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "$schema": "https://raw.githubusercontent.com/justeat/httpclient-interception/master/src/HttpClientInterception/Bundles/http-request-bundle-schema.json", | ||
| "items": [ | ||
| { | ||
| "uri": "https://oauth.pipedrive.com/oauth/token", | ||
| "method": "POST", | ||
| "contentFormat": "json", | ||
| "contentJson": { | ||
| "access_token": "secret-access-token", | ||
| "token_type": "access", | ||
| "refresh_token": "secret-refresh-token", | ||
| "expires_in": "300" | ||
| } | ||
| }, | ||
| { | ||
| "comment": "https://pipedrive.readme.io/docs/marketplace-getting-user-data", | ||
| "uri": "https://api.pipedrive.com/v1/users/me", | ||
| "contentFormat": "json", | ||
| "contentJson": { | ||
| "data": { | ||
| "id": "12345", | ||
| "name": "Test User", | ||
| "email": "testuser@example.com" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } |