很多时候,我们需要对访问的URL进行安全验证。我们通过这段向大家介绍如何通过Alamofire访问需要HTTP简单认证的URL。
服务端的准备
首先我们要在服务端添加一个需要安全验证的HTTP API,基于我们上一个的例子,打开routes.php,添加下面的代码:
Route::group(['middleware' => ['api']], function () {
Route::get('/alamofire', 'AlamofireController@index');
Route::post('/alamofire', [
'middleware' => 'auth.basic.once',
'uses' => 'AlamofireController@store']);
});
这里,我们定义了一个auth.basic.once middleware,用于完成一个无状态的HTTP简单认证。我们来实现它。
在Terminal里,进入apidemo的项目目录,执行下面的命令创建一个middleware:
php artisan make:middleware AuthenticateOnceWithBasicAuth
然后,Laravel会在app/Http/Middleware目录为我们创建一个AuthenticateOnceWithBasicAuth.php,里面会包含一个同名的class。在它的Handle方法里,我们添加下面的代码:
/**
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
return Auth::onceBasic() ?: $next($request);
}
在这里Auth::onceBasic()为我们执行一次无状态的HTTP简单认证(它不会在session里写上),如果它没有返回值,则代表认证成功,我们可以把请求转发到后续的处理逻辑。否则,我们就返回Auth::onceBasic()提供的错误信息。
完成之后,我们打开app/Http/Kernel.php,注册我们之间添加的中间件:
/**
* The application's route middleware.
*
* These middleware may be assigned to groups or used individually.
*
* @var array
*/
protected $routeMiddleware = [
// omit for simplicity
'auth.basic.once' => \App\Http\Middleware\AuthenticateOnceWithBasicAuth::class
];
这样当我们发起POST请求到/alamofire的时候,服务器就会要求认证。为了测试,我们添加一个用户帐号。
首先,在config/database.php里,我们把默认的数据库修改成sqlite(当然,在.env里添加环境变量也可以):
'default' => env('DB_CONNECTION', 'sqlite'),
然后,在terminal里执行:
php artisan migrate
这样,Laravel就会在sqlite里创建users表,然后,执行下面的命令:
php artisan tinker
这样,我们就进入了tinker的控制台,在这里执行下面的代码:
App\User::create([
'email' => '11@boxue.io',
'password' => bcrypt('boxue'),
'name' => '11']);
这样,我们就向数据库中添加了一条User记录。
最后,我们修改一下AlamofireController中处理POST /alamofire的代码:
/**
* Store a newly created resource in storage.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function store(Request $request)
{
//
$data = $request->all();
return response()->json([
'status' => 'successful',
'data' => $data], 201);
}
接下来,我们使用POSTMAN验证一下。
使用Postman
POSTMAN是一个Chrome app,可以很方便的帮我们测试各种HTTP API。我们可以在Chrome extension中找到它。它有两个版本,一个是Chrome插件版,这个版本在Canary上有些问题;还有一个是Chrome app,这里推荐大家使用app版。
打开POSTMAN,按照下图中填写我们的HTTP API信息:
当我们选择HTTP basic auth的时候,POSTMAN会自动为我们生成响应HTTP header:
然后,我们随便填写一个POST BODY:
设置完成后,点击"Send"按钮,我们就可以看到返回的Status是201,内容是我们返回的JSON。
如果我们把密码改成一个错误的值(例如下图:),然后重新发送请求,就可以看到服务器返回的401 - invalid credentials错误了。
在服务端搞定认证之后,接下来,我们来看如何用Alamofire替代POSTMAN发送请求。
使用Alamofire完成请求
在搞定了前面的各种配置和代码之后,用Alamofire发送请求倒是显得格外简单。我们有两种不同的方法可以通过Alamofire访问需要HTTP简单认证的API。
调用authenticate方法
这是最简单的方法,Alamofire有一个authenticate方法,我们直接拿来用就可以了:
回到Xcode,在ViewDidLoad方法里,添加下面的代码:
let user = "11@boxue.io"
let pw = "boxue"
Alamofire.request(.POST, "https://apidemo.boxue.io/alamofire")
.authenticate(user: user, password: pw)
.responseJSON(completionHandler: { response in
debugPrint(response)
})
按Command + R,就可以在控制台,看到了对应的结果了:
除了给authenticate传递用户名和密码外,我们还可以传给它传递一个NSURLCredential对象:
let user = "11@boxue.io"
let pw = "boxue"
let credential = NSURLCredential(user: user,
password: pw,
persistence: .ForSession)
Alamofire.request(.POST, "https://apidemo.boxue.io/alamofire")
.authenticate(usingCredential: credential)
.responseJSON(completionHandler: { response in
debugPrint(response)
})
按Command + R,重新编译执行,我们就可以在控制台里看到,结果是一样的。
自行构造HTTP header
除了使用authenticate方法之外,我们也可以手工构造一个和POSTMAN一样的HTTP header,用于HTTP basic authentication:
let credentialData =
"\(user):\(pw)".dataUsingEncoding(NSUTF8StringEncoding)!
let base64Credentials =
credentialData.base64EncodedStringWithOptions([])
let headers = ["Authorization": "Basic \(base64Credentials)"]
然后,我们把这个header添加到POST请求就可以了:
Alamofire.request(.POST,
"https://apidemo.boxue.io/alamofire",
headers: headers)
.responseJSON(completionHandler: { response in
debugPrint(response)
})
按Command + R,重新编译执行,我们就可以在控制台里看到,结果是一样的。