A2v10.Identity.ApiKey 10.1.8639

About

A2v10.Identity.ApiKey allows the ApiKey authorization for the A2v10 platform applications.

How to use

The ApiKey may be plain text (KeyType.ApiKey) or contain encoded user claims (KeyType.EncodedClaims).

If you use KeyType.EncodedClaims, you must specify the encryption key and vector.

Use

ApiKeyUserHelper<T>.GenerateApiKey(User, Сonfiguration)

for generate encoded ApiKey.

// T - type of user identifier
.AddApiKeyAuthorization<T>(options => {
  // options is read only
});

// configure
services.Configure<ApiKeyConfigurationOptions>(options =>
{
  options.KeyType = KeyType.EncodedClaims; /* or KeyType.ApiKey */
  /* for KeyType.EncodedClaims */
  options.AesEncryptKey = "Aes_Encrypt_Key";
  options.AesEncryptVector = "Aes_Encrypt_Vector";
  options.SkipCheckUser = true;
  /* or */
  options.Configure<Int64>(KeyType.EncodedClaims, Configuration);
});

appsettings.json (for KeyType.EncodedClaims)

"AesEncrypt": {
  "Key": "my_encrypt_key_1", /* 16 chars min */
  "Vector": "my_encrypt_vector_1" /* 16 chars min */
}

Configure Swagger

Add PackageReference to Swashbuckle.AspNetCore:

<PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.4" />

and add the following code to Startup.cs:

using Microsoft.OpenApi;

services.AddSwaggerGen(c =>
{
  c.SwaggerDoc("v3", new OpenApiInfo { Title = API_NAME, Version = "v3" });

  c.AddSecurityDefinition(ApiKeyAuthenticationOptions.Scheme, 
    new OpenApiSecurityScheme()
      {
        Type = SecuritySchemeType.ApiKey,
        In = ParameterLocation.Header,
        Name = ApiKeyAuthenticationOptions.HeaderName,
        Scheme = ApiKeyAuthenticationOptions.Scheme
      }
	);

  c.AddSecurityRequirement(doc => 
    new OpenApiSecurityRequirement()
    {
      {
        new OpenApiSecuritySchemeReference(ApiKeyAuthenticationOptions.Scheme, doc),
        new List<String>()
      }
    }    
  );

  var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
  c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
});

// UseSwagger ALWAYS before app.UseRouting()!

app.UseSwagger();
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v3/swagger.json", $"{API_NAME} v3"));

Related Packages

• A2v10.Identity.Core

Feedback

A2v10.Identity.ApiKey is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.