在设计 HTTP API 的时候,为了使 API 不会被任何人(应用程序)随意使用,并且可以一定程度地知道发送请求的客户端是谁,就必须要有个授权机制。
Simple-Authorization Request Guard for Rocket Framework
「Simple-Authorization Request Guard for Rocket Framework」是笔者开发的套件,利用特性和宏,可以快速地将任意类型实作成请求守卫,这个请求守卫会自动去读取 HTTP 请求中的 Authorization 标头字段。
Crates.io
Cargo.toml
使用方法
使用这个套件来实作授权机制可以分为四个步骤。
步骤一:定义一个结构体或是枚举,并实作它的方法,使它之后可以方便地被用来当作请求守卫来使用。注意,在这个步骤先不要自行实作 rocket::request::FromRequest 特性,因为这个套件就是为了要避开自行实作 rocket::request::FromRequest 特性所带来的麻烦,如果自行实作 rocket::request::FromRequest 特性就没有意义了。
举例来说:
pub struct Auth {
account: String
}
impl Auth {
pub fn as_str(&self) -> &str {
self.account.as_str()
}
}
我们希望以上这个 Auth 结构体,可以在处理 HTTP 请求时,去检查 Authorization 标头字段中的值是否为某个用户的记号(token),检查成功后,account 字段会将用户的帐号保存下来。而这里的用户的记号其实就是用户的帐号经过 ShortCrypt 加密之后的值。
步骤二:实作 rocket_simple_authorization 这个 crate 提供的 SimpleAuthorization 特性。SimpleAuthorization 特性只有一个方法需要实作,那就是 authorizing。authorizing 方法要负责检查 Authorization 标头字段中保存的用户记号,将其解密成用户帐号之后,创建出 Auth 结构实体并回传。
程序如下:
use rocket::request::Request;
use rocket_simple_authorization::SimpleAuthorization;
#[async_trait]
impl<'r> SimpleAuthorization<'r> for Auth {
async fn authorizing(request: &'r Request<'_>, authorization: Option<&'r str>) -> Option<Self> {
let sc = request.rocket().state::<ShortCrypt>().unwrap();
match authorization {
Some(authorization) => {
match sc.decrypt_url_component(authorization) {
Ok(result) => {
match String::from_utf8(result) {
Ok(user_name) => {
Some(Auth {
account: user_name,
})
}
Err(_) => None,
}
}
Err(_) => None,
}
}
None => None,
}
}
}
以上程序,利用 rocket::request::Request 结构实体的 rocket 方法取得 Rocket 结构实体,再用其 state 方法来取得保存在应用程序状态中的 ShortCrypt。
步骤三:利用 authorizer 宏,将实作好 SimpleAuthorization 特性的结构体或是枚举做成请求守卫。
程序如下:
authorizer!(Auth);
如果要使请求守卫支持 Rocket 框架的请求状态,可以将程序写成:
authorizer!(ref Auth);
一般来说,权限相关等会需要进行加解密、访问数据库的请求守卫,都需要利用请求状态来避免被运行多次。
步骤四:将请求守卫应用在路由处理程序的参数中。
例如:
#[get("/time")]
fn system_time(auth: &Auth) -> Option<String> {
match auth.as_str() {
"magiclen.org" => (),
_ => return None
}
let utc: DateTime<Utc> = Utc::now();
Some(utc.format("%Y-%m-%d-%H-%M-%S").to_string())
}
以上程序,只有当用户帐号为 magiclen.org 时,才可以正常地使用 GET /time 这支 HTTP API。
