finagle/finagle-oauth2

OAuth2 Server-Side Provider for Finagle

OAuth2 Provider for Finagle

This is a Finagle-friendly version of scala-oauth2-provider.

User Guide

1. Implement com.twitter.finagle.oauth2.DataHandler using your own data store (in-memory, DB, etc).
2. Use com.twitter.finagle.OAuth2 API to authorize requests and issue access tokens.

A service that emits OAuth2 access tokens based on request's credentials.

import com.twitter.finagle.OAuth2
import com.twitter.finagle.oauth2.{OAuthError, DataHandler}

import com.twitter.finagle.http.{Request, Response, Version, Status}
import com.twitter.finagle.Service
import com.twitter.util.Future

val dataHandler: DataHandler[?] = ???

object TokenService extends Service[Request, Response] with OAuth2 {
  def apply(req: Request): Future[Response] =
    issueAccessToken(req, dataHandler).flatMap { token =>
      val rep = Response(Version.Http11, Status.Ok)
      rep.setContentString(token.accessToken)
      Future.value(rep)
    } handle {
      case e: OAuthError => e.toResponse
    }
}

A service that checks whether the request contains a valid token.

import com.twitter.finagle.OAuth2
import com.twitter.finagle.oauth2.{OAuthError, DataHandler}

import com.twitter.finagle.http.{Request, Response, Version, Status}
import com.twitter.finagle.Service
import com.twitter.util.Future

object ProtectedService extends Service[Request, Response] with OAuth2 {
  def apply(req: Request): Future[Response] =
    authorize(req, dataHandler).flatMap { authInfo =>
      val rep = Response(Version.Http11, Status.Ok)
      rep.setContentString(s"Hello ${authInfo.user}!")
      Future.value(rep)
    } handle {
      case e: OAuthError => e.toResponse
    }
}

finagle-oauth2's Issues

OAuthError should be convertible to Response

oAuthErrorToHttpResponse method in OAuth2

Update for Finagle 6.42.0

Updating to Finagle 6.42.0 leads to errors such as this:
java.lang.NoSuchMethodError: com.twitter.finagle.http.HeaderMap.getAll

Would it be possible to get a new compatible release?

OAuth2Filter should be configurable in terms of response

I'm thinking of trait mixing idea:

trait OAuthErrorHandler {
  def handleError(e: OAuthError): Response = ???
}
val auth = new OAuth2Filter(dataHandler) with OAuthErrorInJson

Update Reame with suitable examples

There is only one way to implement token service. But the protected service might be implemented in two usage ways of finagle-oauth2: w/o filter and w/ type-safe filter.

Make sure headers are correct

WWW-Authenticate: Bearer List(error="invalid_request", e, r, r, o, r, _, d, e, s, c, r, i, p, t, i, o, n, =, ", r, e, q, u, i, r, e, d,  , p, a, r, a, m, e, t, e, r, :,  , u, s, e, r, n, a, m, e, ")

Releasing with Bintray

Instead of using custom server.

We can use trait mixing for token service

Like this:

trait OAuthTokenConverter {
  def convertToken(t: Token): Response
}
val tokenizer = new OAuth2Endpoint(dataHandler) with OAuthTokenInJson with OAuthErrorInJson

Migrate old tests to finagle-oauth2

OAuth2 Implicit grant type

Not sure where to ask this question, I'm about to implement OAuth2 for my application and the suitable grant type for my application is implicit. I've noticed that this library is not supporting it (or am I missing it), but the scala-oauth library does have it.

Is there a particular reason why it's not present and can I give it a shot to add it to this project?

Update Readme with OAuthEndpoint examples

Authentification Filters

case class AuthorizedRequest[U](authInfo: AuthInfo[U]) extends RequestProxy

val f = new AuthentificateFilter[User] with OAuth2 {
  def apply(req: Request, service: Service[AuthorizedRequest[User], Response]): Future[Response] =
    // try authorize
    service(AuthorizedRequest(authInfo))
    // else bad request
}

Bump version to 18.8.0

ditto