scala - 使用 BasicAuth 进行喷射身份验证方法

Question

喷雾很难!!我现在知道我对 HTTP 协议(protocol)的了解还远远不够，API 设计也不容易。然而，我仍然非常希望我的练习应用程序能够工作。我正在为 POST/PUT/DELETE 方法编写此身份验证。看来至少有两种方法可以做到这一点:BasicAuth 或编写自定义指令。

我找到这篇文章:

基本身份验证:https://github.com/jacobus/s4/blob/master/src/main/scala/s4/rest/S4Service.scala

我正在尝试它，因为它看起来很简单。

编译和运行阶段都很好，并且服务器运行。但是，当我尝试发送 PUT 请求来测试实现时(使用 Python 的 Httpie:http PUT 127.0.0.1:8080/sec-company/casper username=username token=123)，反馈是:HTTP/1.1 404 Not Found

这是我的路线:

pathPrefix("sec-company") {
        path("casper") {
          //first examine username and token
          authenticate(BasicAuth(CustomUserPassAuthenticator, "company-security")) {userProfile =>
            post { ctx =>
              entity(as[Company.Company]) { company =>
                complete {
                  company
                }
              }
            }
   }

这是我的 UserPassAuthenticator 实现:

object CustomUserPassAuthenticator extends UserPassAuthenticator[UserProfile] {
    def apply(userPass: Option[UserPass]) = Promise.successful(
      userPass match {
        case Some(UserPass(user, token)) => getUserProfile(user, token)
        case _ => None
      }
    ).future
  }

首先，这是实现身份验证的正确方法吗？其次，UserPassAuthenticator在哪里找到用户名和密码？我可以发回除 404 之外更好的 HTTP header 来指示身份验证失败吗？

如果这远远不正确，是否有任何我可以遵循的身份验证教程？ TypeSafe 的 Spray 模板更多的是关于整体模式，而不是关于 Spray 的功能!

谢谢!

Answer 1

即使在查看 https://github.com/spray/spray/wiki/Authentication-Authorization 后我也遇到了同样的问题(它说它适用于旧版本的 Akka，但它似乎仍然适用)我想出了以下内容:

trait Authenticator {
  def basicUserAuthenticator(implicit ec: ExecutionContext): AuthMagnet[AuthInfo] = {
    def validateUser(userPass: Option[UserPass]): Option[AuthInfo] = {
      for {
        p <- userPass
        user <- Repository.apiUsers(p.user)
        if user.passwordMatches(p.pass)
      } yield AuthInfo(user)
    }

    def authenticator(userPass: Option[UserPass]): Future[Option[AuthInfo]] = Future { validateUser(userPass) }

    BasicAuth(authenticator _, realm = "Private API")
  }
}

我将此特征混合到运行路线的 Actor 中，然后这样调用它:

runRoute(
  pathPrefix("api") {
    authenticate(basicUserAuthenticator) { authInfo =>
      path("private") {
        get {
          authorize(authInfo.hasPermission("get") {
            // ... and so on and so forth
          }
        }
      }
    }
  }
}

由 validateUser 方法返回的 AuthInfo 对象作为参数传递给给 authorize 方法的闭包。这是:

case class AuthInfo(user: ApiUser) {
  def hasPermission(permission: String) = user.hasPermission(permission)
}

在 Spray(和 HTTP)中，身份验证(确定是否拥有有效用户)与授权(确定用户是否有权访问资源)是分开的。在 ApiUser 类中，我还存储用户拥有的权限集。这是一个简化版本，我的 hasPermission 方法有点复杂，因为我还参数化了权限，所以不仅仅是特定用户有权获取资源，他可能有权只读该资源的某些部分。您可以使事情变得非常简单(任何登录用户都可以访问任何资源)或非常复杂，具体取决于您的需要。

至于您的问题，当使用 HTTP BASIC 身份验证(BasicAuth 对象)时，凭据将在请求的 Authorization: header 中传递。您的 HTTP 库应该负责为您生成它。根据 HTTP 标准，如果身份验证不正确或未提供，服务器应返回 401 状态代码；如果身份验证正确但用户无权查看内容，则服务器应返回 403 状态代码。