Skip to content

Feature/provider settings extending #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feature/provider settings extending #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f07648
Default names, description and examples added
NickRimmer Apr 5, 2025
f8360f0
descriptions added
NickRimmer Apr 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/Extensions/RestApia.Extensions.Auth.Basic/BasicAuthService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ public class BasicAuthService: IAuthValuesProvider
{
private static readonly ValuesProviderSettings Settings = new ()
{
Title = "Basic Authorization",
Title = "Basic Authentication",
DefaultName = "Basic Auth",
Description = "Provide your login ID and password. RestApia will take these details and include them in the request header using the Basic Authentication standard.",
CanBeReloaded = true,
DisableCachingResults = true,
ReservedValues =
[
new () { Name = nameof(BasicAuthSettings.Name), Description = "User name", IsRequired = true, Placeholder = "User" },
new () { Name = nameof(BasicAuthSettings.Password), Description = "User Password", Placeholder = "secret" },
new () { Name = nameof(BasicAuthSettings.Name), Description = "Login identifier or username", IsRequired = true, Placeholder = "user" },
new () { Name = nameof(BasicAuthSettings.Password), Description = "Your secret password", Placeholder = "password" },
],
};

Expand Down
78 changes: 66 additions & 12 deletions src/Extensions/RestApia.Extensions.Auth.OAuth2/AuthCode/OAuth2AuthCodeService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,96 +12,150 @@
using RestApia.Shared.Extensions.ValuesProviderService.Models;
namespace RestApia.Extensions.Auth.OAuth2.AuthCode;

public class OAuth2AuthCodeService: IAuthValuesProvider
public class OAuth2AuthCodeService : IAuthValuesProvider
{
private static readonly HttpClient AccessTokenHttpClient = new ();

private static readonly ValuesProviderSettings Settings = new ()
{
Title = "OAuth2: Auth Code",
DefaultName = "OAuth2 Auth Code",
Description = "A window will open, taking you to the service provider's page to log in and grant permission. Credentials provider will then issue a JWT token, which will be automatically used as Bearer authorization header.",
CanBeReloaded = true,

ReservedValues =
[
new ()
{
Name = nameof(OAuth2AuthCodeSettings.AuthUrl),
Description = "Authorization URL",
Description = "Authorization endpoint",
IsRequired = true,
Placeholder = "https://example.com/oauth2/authorize",
},
new ()
{
Name = nameof(OAuth2AuthCodeSettings.TokenUrl),
Description = "Access Token URL",
Description = "Access token endpoint",
IsRequired = true,
Placeholder = "https://example.com/oauth2/token",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.RedirectUrl),
Description = "Redirect URL",
Description = "Callback URL after authorization",
IsRequired = true,
Placeholder = "https://example.com/oauth2/callback",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.ClientId),
Description = "Client ID",
Description = "Your application's public identifier",
IsRequired = true,
Placeholder = Guid.Empty.ToString(),
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.ClientSecret),
Description = "Client Secret",
Description = "Your application's secret key",
Placeholder = "****************",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.SendMethod),
Description = "Credentials sending method",
Description = "How to send client credentials",
Placeholder = "header or body",
ExpectedValues = [string.Empty, null, "header", "body"], // empty string is
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.Scopes),
Description = "Scopes",
Description = "Requested permissions",
Placeholder = "email; profile",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.Audience),
Description = "Audience",
Description = "Target resource server",
Placeholder = "https://example.com/api",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.State),
Description = "State",
Description = "Optional security token",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.Resource),
Description = "Resource",
Description = "Specific resource to access",
},

new ()
{
Name = nameof(OAuth2AuthCodeSettings.Origin),
Description = "Origin",
Description = "The origin of the request",
Placeholder = "https://example.com",
},
],

Examples = new Dictionary<string, string>
{
{
"Default", string.Join("\n", [
"AuthUrl: https://your-auth-provider.com/oauth2/authorize",
"TokenUrl: https://your-auth-provider.com/oauth2/token",
"RedirectUrl: https://localhost/auth_callback",
"ClientId: your_client_id",
"ClientSecret: your_client_secret",
])
},
{
"Azure - Entra Id", string.Join("\n", [
"// Usually defined as environment variables",
"// host: https://localhost:1234",
"// EntraId.Client: 019607db-89cd-7b36-a6ba-005cafd23fd2",
"// EntraId.Secret: your_entra_id_client_secret",
"// EntraId.Scopes: api://restapia-demo/Test",
string.Empty,
"// values",
"EntraId.TenantId: 019606ad-ba48-77dd-b008-9354e8bd9d7d",
string.Empty,
"// settings",
"AuthUrl: https://login.microsoftonline.com/{{EntraId.TenantId}}/oauth2/v2.0/authorize",
"TokenUrl: https://login.microsoftonline.com/{{EntraId.TenantId}}/oauth2/v2.0/token",
"RedirectUrl: {{host}}/oauth2-callback",
"ClientId: {{EntraId.Client}}",
"ClientSecret: {{EntraId.Secret}}",
"Scopes: {{EntraId.Scopes}}",
"SendMethod: body", // Or "header", depending on Entra ID configuration
])
},
{
"Google OAuth 2.0", string.Join("\n", [
"// Usually defined as environment variables",
"// host: https://localhost:1234",
"// Google.Client: your_google_client_id",
"// Google.Secret: your_google_client_secret",
"// Google.Scopes: https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
string.Empty,
"// settings",
"AuthUrl: https://accounts.google.com/o/oauth2/v2/auth",
"TokenUrl: https://oauth2.googleapis.com/token",
"RedirectUrl: {{host}}/oauth2-callback",
"ClientId: {{Google.Client}}",
"ClientSecret: {{Google.Secret}}",
"Scopes: {{Google.Scopes}}",
"SendMethod: body",
])
},
},
};

private readonly ILogger _logger;
Expand Down
58 changes: 52 additions & 6 deletions src/Extensions/RestApia.Extensions.Auth.OAuth2/Implicit/OAuth2ImplicitService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,98 @@
using RestApia.Shared.Extensions.ValuesProviderService.Models;
namespace RestApia.Extensions.Auth.OAuth2.Implicit;

public class OAuth2ImplicitService: IAuthValuesProvider
public class OAuth2ImplicitService : IAuthValuesProvider
{
private static readonly ValuesProviderSettings Settings = new ()
{
Title = "OAuth2: Implicit",
DefaultName = "OAuth2 Implicit",
Description = "A window will open, taking you to the service provider to grant permission. Upon approval, an access token will be directly provided and automatically used as Bearer authorization header.",
CanBeReloaded = true,
ReservedValues =
[
new ()
{
Name = nameof(OAuth2ImplicitSettings.AuthUrl),
Description = "Authorization URL",
Description = "Authorization endpoint URL",
IsRequired = true,
Placeholder = "https://example.com/oauth2/authorize",
},

new ()
{
Name = nameof(OAuth2ImplicitSettings.RedirectUrl),
Description = "Redirect URL",
Description = "Callback URL after authorization",
IsRequired = true,
Placeholder = "https://example.com/oauth2/callback",
},

new ()
{
Name = nameof(OAuth2ImplicitSettings.ClientId),
Description = "Client ID",
Description = "Your application's public identifier",
IsRequired = true,
Placeholder = Guid.Empty.ToString(),
},

new ()
{
Name = nameof(OAuth2ImplicitSettings.Scopes),
Description = "Scopes",
Description = "Permissions your application requests",
Placeholder = "email; profile",
},

new ()
{
Name = nameof(OAuth2ImplicitSettings.Audience),
Description = "Audience",
Description = "Target resource server",
Placeholder = "https://example.com/api",
},
],
Examples = new Dictionary<string, string>
{
{
"Default", string.Join("\n", [
"AuthUrl: https://your-auth-provider.com/authorize",
"RedirectUrl: https://localhost/auth_callback",
"ClientId: 00000000-0000-0000-0000-000000000000",
])
},
{
"Azure - Entra Id", string.Join("\n", [
"// Usually defined as environment variables",
"// host: https://localhost:1234",
"// EntraId.Client: 019607db-89cd-7b36-a6ba-005cafd23fd2",
"// EntraId.Scopes: api://restapia-demo/Test",
string.Empty,
"// values",
"EntraId.TenantId: 019606ad-ba48-77dd-b008-9354e8bd9d7d",
string.Empty,
"// settings",
"AuthUrl: https://login.microsoftonline.com/{{EntraId.TenantId}}/oauth2/v2.0/authorize",
"RedirectUrl: {{host}}/oauth2-callback",
"ClientId: {{EntraId.Client}}",
"Scopes: {{EntraId.Scopes}}",
])
},
{
"AWS", string.Join("\n", [
"// Usually defined as environment variables",
"// host: https://localhost:1234",
"// AWS.Client: 019607db-89cd-7b36-a6ba-005cafd23fd2",
"// AWS.Scopes: openid",
string.Empty,
"// values",
"AWS.Prefix: restapia-auth",
string.Empty,
"// settings",
"AuthUrl: https://{{AWS.Prefix}}.auth.us-east-1.amazoncognito.com/oauth2/authorize",
"RedirectUrl: {{host}}/oauth2-callback",
"ClientId: {{AWS.Client}}",
"Scopes: {{AWS.Scopes}}",
])
},
},
};

private readonly ILogger _logger;
Expand Down
4 changes: 3 additions & 1 deletion .../RestApia.Extensions.ValuesProvider.CollectionValuesProvider/EnvironmentValuesProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ public class EnvironmentValuesProvider: IEnvironmentValuesProvider
// no reserved values or custom controls
public ValuesProviderSettings GetProviderSettings() => new ()
{
Title = "User Values",
Title = "Environment Values",
DefaultName = "DEV",
Description = "Environments help you keep your API interactions organized by separating configurations for different stages or versions of the APIs you are using. You can create multiple environments, each with its own set of values, headers and cookies.",
CanBeReloaded = false,
DisableCachingResults = true,
HelpPageUrl = "https://github.com/RestApia/RestApia.Shared/tree/main/src/Extensions/RestApia.Extensions.ValuesProvider.CollectionValuesProvider",
Expand Down
1 change: 1 addition & 0 deletions ...ensions/RestApia.Extensions.ValuesProvider.CollectionValuesProvider/UserValuesProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ public class UserValuesProvider: IUserValuesProvider
public ValuesProviderSettings GetProviderSettings() => new ()
{
Title = "User Values",
DefaultName = "Global values",
CanBeReloaded = false,
DisableCachingResults = true,
HelpPageUrl = "https://github.com/RestApia/RestApia.Shared/tree/main/src/Extensions/RestApia.Extensions.ValuesProvider.CollectionValuesProvider",
Expand Down
4 changes: 3 additions & 1 deletion src/RestApia.Shared/Extensions/ValuesProviderService/Models/ValuesProviderSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
public record ValuesProviderSettings
{
public required string Title { get; init; }
public required string DefaultName { get; init; } = string.Empty;

public bool CanBeReloaded { get; init; }
public bool DisableCachingResults { get; init; }
public string HelpPageUrl { get; init; } = string.Empty;
public string DefaultName { get; init; } = string.Empty;
public string Description { get; init; } = string.Empty;

public IReadOnlyCollection<ReservedValueInfo> ReservedValues { get; init; } = [];
public IReadOnlyDictionary<string, string> Examples { get; init; } = new Dictionary<string, string>();
}