Notifications
Mark all as read
Q&A

How can I add "withCredentials:true" for HTTP requests generated by Swagger UI?

+3
−0

I have added Swagger UI for an ASP.NET Core 3.1 application and I have realized that all endpoints requiring Windows Authentication fail. This issue is created by the fact that generated HTTP requests do not include withCredentials (what I used in the Angular client consuming the same API).

This Swagger project thread indicates that the UI can be changed to include such an option, but this requires to customize the Swagger.UI which it is something I do not want at this point.

Is there any other way to fix this issue?

Why should this post be closed?

0 comments

1 answer

+0
−0

One way to solve this without customizing the Swagger UI is to deal with it on the server side. The following assumes that the swagger docs is served at /swagger relative path.

Middleware

/// <summary>
/// Middleware to protect API Swagger docs
/// </summary>
public class SwaggerAuthorizationMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger _logger;

    public SwaggerAuthorizationMiddleware(RequestDelegate next, ILogger<SwaggerAuthorizationMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task Invoke(HttpContext context)
    {
        // If API documentation route and user isn't authenticated or doesn't have the appropriate authorization, then block
        if (context.Request.Path.StartsWithSegments("/swagger") && !context.User.Identity.IsAuthenticated)
        {
            _logger.LogWarning($"API documentation endpoint unauthorized access attempt by [{context.Connection.RemoteIpAddress}]");
            context.Response.StatusCode = StatusCodes.Status401Unauthorized;
            return;
        }

        await _next.Invoke(context);
    }

Startup (in Configure method)

 app.UseAuthentication();
 app.UseAuthorization();

 app.UseMiddleware<SwaggerAuthorizationMiddleware>();

Reference

0 comments

Sign up to answer this question »