The OAuth 2.0 server-side implementation written in Scala.
This provides OAuth 2.0 server-side functionality and supporting function for Playframework. Playframework 2.1 and 2.2 are now supported.
The idea of this library originally comes from oauth2-server which is Java implementation of OAuth 2.0.
This library currently supports three grant types as follows
- Authorization Code Grant
- Resource Owner Password Credentials Grant
- Client Credentials Grant
and an access token type called Bearer.
If you'd like to use this with Playframework, add "play2-oauth2-provider" to library dependencies of your project.
libraryDependencies ++= Seq(
"com.nulab-inc" %% "play2-oauth2-provider" % "0.3.0"
)
Otherwise, add "scala-oauth2-core" instead. In this case, you need to implement your own OAuth provider working with web framework you use.
libraryDependencies ++= Seq(
"com.nulab-inc" %% "scala-oauth2-core" % "0.3.0"
)
Whether you use Playframework or not, you have to implement DataHandler trait and make it work with your own "User" class that may be already defined in your application.
case class User(id: Long, name: String, hashedPassword: String)
class MyDataHandler extends DataHandler[User] {
def validateClient(clientId: String, clientSecret: String, grantType: String): Boolean = ???
def findUser(username: String, password: String): Option[User] = ???
def createAccessToken(authInfo: AuthInfo[User]): AccessToken = ???
def getStoredAccessToken(authInfo: AuthInfo[User]): Option[AccessToken] = ???
def refreshAccessToken(authInfo: AuthInfo[User], refreshToken: String): AccessToken = ???
def findAuthInfoByCode(code: String): Option[AuthInfo[User]] = ???
def findAuthInfoByRefreshToken(refreshToken: String): Option[AuthInfo[User]] = ???
def findClientUser(clientId: String, clientSecret: String, scope: Option[String]): Option[User] = ???
def findAccessToken(token: String): Option[AccessToken] = ???
def findAuthInfoByAccessToken(accessToken: AccessToken): Option[AuthInfo[User]] = ???
}
For more details, refer to Scaladoc of DataHandler.
You should follow three steps below to work with Playframework.
- Define a controller to issue access token
- Assign a route to the controller
- Access to an authorized resource
First, define your own controller with mixining OAuth2Provider trait provided by this library to issue access token.
import scalaoauth2.provider._
object OAuth2Controller extends Controller with OAuth2Provider {
def accessToken = Action { implicit request =>
issueAccessToken(new MyDataHandler())
}
}
Then, assign a route to the controller that OAuth clients will access to.
POST /oauth2/access_token controllers.OAuth2Controller.accessToken
Finally, you can access to an authorized resource like this:
import scalaoauth2.provider._
object MyController extends Controller with OAuth2Provider {
def list = Action { implicit request =>
authorize(new MyDataHandler()) { authInfo =>
val user = authInfo.user // User is defined on your system
// access resource for the user
}
}
}
If you'd like to change the OAuth workflow, modify handleRequest methods of TokenEndPoint and ProtectedResource traits.