NancyFX authentication for REST API

NancyFX is a great .NET framework well suited for creating REST APIs. There are many ways how to approach authentication, the simplest one is the good old Forms Authentication. The idea of Forms Authentication is that the user logs in with a username and password and gets a cookie, the protected endpoints then check the cookie. NancyFX supports Forms Authentication with the Nancy.Authentication.Forms package. The documentation describes how to use it on a web page, but to use it with a REST API a few changes are needed.

Forms Authentication differences for REST API

There are things you want to do differently in a REST API than on a web page. If a user tries to access a protected endpoint, the Forms Authentication on a normal web page redirects him to the login page. In REST API, you typically want the endpoint just to return HTTP 401, no redirects. Also, when a user successfully logs in, you just typically want to return HTTP 200, no redirects.

Disabling redirects

Suppose you have Forms Authentication set up according to the documentation, with a IUserMapper and IUserIdentity implementation. Disabling the redirects is easy, just set a flag on the FormsAuthenticationConfiguration in your Bootstrapper:

protected override void RequestStartup(TinyIoCContainer container, IPipelines pipelines, NancyContext context)
{
    base.RequestStartup(container, pipelines, context);

    var formsAuthConfiguration =
        new FormsAuthenticationConfiguration()
        {
            DisableRedirect = true,
            UserMapper = container.Resolve<IUserMapper>()
        };

    FormsAuthentication.Enable(pipelines, formsAuthConfiguration);
}

Changing Login and Logout methods

The login implementation from the documentation uses the LoginAndRedirect method. There is also LoginWithoutRedirect method you want to use, but I found out it does not set the authentication cookie (when it does not think the request is an AJAX request), so the login basically does not work. A workaround I found is to call the LoginAndRedirect method, but only get the authentication cookie from the response ad return it manually:

Post["/login"] = _ =>
{
    var loginParams = this.Bind<LoginParams>();
    var user = _userService.Get(loginParams.Username, loginParams.Password);
    if (user == null)
    {
        return HttpStatusCode.Unauthorized;
    }
    
    var authResult = this.LoginAndRedirect(user.Guid);                
    return Response.AsJson(new
    {
        username = user.Username
    }).WithCookie(authResult.Cookies.First());
};

The logout implementation just needs to call LogoutWithoutRedirect and return HTTP 200:

Get["/logout"] = _ =>
{             
    this.RequiresAuthentication();

    var response = this.LogoutWithoutRedirect();
    return Response.AsText("logout").WithCookie(response.Cookies.First());
};

See also