Take.Security.AccessControl 1.0.2

Informations

This package is responsible for managing tokens, enabling more security in accesses between bot (Take Blip) and API's. Tokens are managed by the package and saved in the bot's Bucket (https://docs.blip.ai/#bucket). The name of the document in the bucket is tokenAccessControl

Usage

After installing the package, you'll need to tell your API to use this scheme in the Startup.cs file. The simplest way is using the extension method provided with the package:

public void ConfigureServices(IServiceCollection services)
{
    // ...
    services.UseBotAuthenticationJwt("bot identifier", "bot accesskey");
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
    app.UseHttpsRedirection()
       .UseAuthentication() // this is the line that should be added, and it MUST be before .UseRouting()
       .UseRouting()
    // ...
}

Once your API is configured to use it, you can enable it on a controller like so:

[Route("api/[controller]")]
[ApiController]
[Authorize] // add this to protect the whole controller
public class HealthController : ControllerBase
{

}

To protect only a given method:

[Route("api/[controller]")]
[ApiController]
public class HealthController : ControllerBase
{
    [HttpGet, Authorize] // add the Authorize attribute here instead, to protect only the action
    public IActionResult HealthCheck() {} 
}

To exclude a given method from a protected controller:

[Route("api/[controller]")]
[ApiController, Authorize] // add the attribute
public class HealthController : ControllerBase
{
    [HttpGet, AllowAnonymous] // Methods with AllowAnonymous will ignore the auth check
    public IActionResult HealthCheck() {}
    
    [HttpGet("authorize")] // Even without the explicit attribute, this will be protected by the one on the controller
    public IActionResult KeyCheck() {}
}

If you used Authorization, define the schema to know which Authorization you are using. The schema used is BotAuthenticationJwt

[Route("api/[controller]")]
[ApiController]
public class HealthController : ControllerBase
{
    [Authorize(AuthenticationSchemes = "BotAuthenticationJwt")]
    [HttpGet]
    public IActionResult HealthCheck() {} 
}

To use the generated token, you must send the Key: Authorization; Value: Bearer {{bucket.tokenAccessControl@key}}, as you can see in the image:

Remembering that the key will be created as soon as you run Startup.cs