Accounts
@@ -55,6 +55,25 @@
Manage the Flexisip accounts
+
+ API Key
+
+ As an administrator you can generate an API key and use it to request the different API endpoints, check the related API documentation to know how to use that key.
+
+ {!! Form::open(['route' => 'admin.api_key.generate']) !!}
+
+{!! Form::close() !!}
@endif
Account information
diff --git a/flexiapi/resources/views/documentation.blade.php b/flexiapi/resources/views/documentation.blade.php
index 8c3eefb..e2fcb81 100644
--- a/flexiapi/resources/views/documentation.blade.php
+++ b/flexiapi/resources/views/documentation.blade.php
@@ -14,7 +14,23 @@
> accept: application/json
Authentication
-Restricted endpoints are protected using a DIGEST authentication mechanism.
+
+Restricted endpoints are protected using a DIGEST authentication or an API Key mechanisms.
+
+Using the API Key
+
+To authenticate using an API Key, you need to authenticate to your account panel and being an administrator.
+On your panel you will then find a form to generate your personnal key.
+
+You can then use your freshly generated key by adding a new x-api-key header to your API requests:
+
+
+ > GET /api/{endpoint}
+ > from: sip:foobar@sip.example.org
+ > x-api-key: {your-api-key}
+ > …
+
+Using DIGEST
To discover the available hashing algorythm you MUST send an unauthenticated request to one of the restricted endpoints.
For the moment only DIGEST-MD5 and DIGEST-SHA-256 are supported through the authentication layer.
@@ -43,6 +59,7 @@ For the moment only DIGEST-MD5 and DIGEST-SHA-256 are supported through the auth
password required minimum 6 characters
algorithm required, values can be SHA-256 or MD5
domain optional, the value is set to the default registration domain if not set
+ activated optional, a boolean, set to false by default
To create an account directly from the API.
This endpoint is authenticated and requires an admin account.
diff --git a/flexiapi/routes/api.php b/flexiapi/routes/api.php
index cecc695..8e46595 100644
--- a/flexiapi/routes/api.php
+++ b/flexiapi/routes/api.php
@@ -25,7 +25,7 @@ Route::middleware('auth:api')->get('/user', function (Request $request) {
return $request->user();
});
-Route::group(['middleware' => ['auth.digest']], function () {
+Route::group(['middleware' => ['auth.digest_or_key']], function () {
Route::get('ping', 'Api\PingController@ping');
Route::get('devices', 'Api\DeviceController@index');
Route::delete('devices/{uuid}', 'Api\DeviceController@destroy');
diff --git a/flexiapi/routes/web.php b/flexiapi/routes/web.php
index 49cc637..79ff042 100644
--- a/flexiapi/routes/web.php
+++ b/flexiapi/routes/web.php
@@ -66,6 +66,8 @@ Route::group(['middleware' => 'auth.admin'], function () {
Route::get('admin/accounts/{search?}', 'Admin\AccountController@index')->name('admin.account.index');
Route::post('admin/search', 'Admin\AccountController@search')->name('admin.account.search');
+ Route::post('admin/api_key', 'Admin\AccountController@generateApiKey')->name('admin.api_key.generate');
+
Route::get('admin/accounts/show/{id}', 'Admin\AccountController@show')->name('admin.account.show');
Route::get('admin/accounts/{id}/activate', 'Admin\AccountController@activate')->name('admin.account.activate');
Route::get('admin/accounts/{id}/deactivate', 'Admin\AccountController@deactivate')->name('admin.account.deactivate');
diff --git a/flexiapi/tests/Feature/AccountApiTest.php b/flexiapi/tests/Feature/AccountApiTest.php
index ca07419..964252c 100644
--- a/flexiapi/tests/Feature/AccountApiTest.php
+++ b/flexiapi/tests/Feature/AccountApiTest.php
@@ -71,7 +71,8 @@ class AccountApiTest extends TestCase
->assertStatus(200)
->assertJson([
'id' => 2,
- 'username' => $username
+ 'username' => $username,
+ 'activated' => false,
]);
}
@@ -97,6 +98,7 @@ class AccountApiTest extends TestCase
'id' => 2,
'username' => $username,
'domain' => $domain,
+ 'activated' => false,
]);
}
@@ -121,6 +123,7 @@ class AccountApiTest extends TestCase
'id' => 2,
'username' => $username,
'domain' => config('app.sip_domain'),
+ 'activated' => false,
]);
}
@@ -129,8 +132,6 @@ class AccountApiTest extends TestCase
$admin = Admin::factory()->create();
$password = $admin->account->passwords()->first();
- $username = 'username';
-
$response0 = $this->generateFirstResponse($password);
$response1 = $this->generateSecondResponse($password, $response0)
->json($this->method, $this->route, [
@@ -141,4 +142,30 @@ class AccountApiTest extends TestCase
$response1->assertStatus(422);
}
+
+ public function testActivated()
+ {
+ $admin = Admin::factory()->create();
+ $password = $admin->account->passwords()->first();
+
+ $username = 'username';
+
+ $response0 = $this->generateFirstResponse($password);
+ $response1 = $this->generateSecondResponse($password, $response0)
+ ->json($this->method, $this->route, [
+ 'username' => $username,
+ 'algorithm' => 'SHA-256',
+ 'password' => '2',
+ 'activated' => true,
+ ]);
+
+ $response1
+ ->assertStatus(200)
+ ->assertJson([
+ 'id' => 2,
+ 'username' => $username,
+ 'domain' => config('app.sip_domain'),
+ 'activated' => true,
+ ]);;
+ }
}
diff --git a/flexiapi/tests/Feature/AuthenticateDigestTest.php b/flexiapi/tests/Feature/AuthenticateDigestAndKeyTest.php
similarity index 94%
rename from flexiapi/tests/Feature/AuthenticateDigestTest.php
rename to flexiapi/tests/Feature/AuthenticateDigestAndKeyTest.php
index 1e9347f..82b9271 100644
--- a/flexiapi/tests/Feature/AuthenticateDigestTest.php
+++ b/flexiapi/tests/Feature/AuthenticateDigestAndKeyTest.php
@@ -25,7 +25,7 @@ use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;
-class AuthenticateDigestTest extends TestCase
+class AuthenticateDigestAndKeyTest extends TestCase
{
use RefreshDatabase;
@@ -58,6 +58,18 @@ class AuthenticateDigestTest extends TestCase
$response->assertStatus(401);
}
+ public function testAuthenticateWithKey()
+ {
+ $password = Password::factory()->create();
+ $password->account->generateApiKey();
+
+ $response = $this->withHeaders([
+ 'From' => 'sip:'.$password->account->identifier,
+ 'x-api-key' => $password->account->apiKey->key,
+ ])->json($this->method, $this->route);
+ $response->assertStatus(200);
+ }
+
public function testMultiHash()
{
// Two password and we link the second to the first related account
diff --git a/flexisip-account-manager.spec b/flexisip-account-manager.spec
index 4b0c222..99a2f24 100644
--- a/flexisip-account-manager.spec
+++ b/flexisip-account-manager.spec
@@ -8,7 +8,7 @@
#%define _datadir %{_datarootdir}
#%define _docdir %{_datadir}/doc
-%define build_number 32
+%define build_number 34
%define var_dir /var/opt/belledonne-communications
%define opt_dir /opt/belledonne-communications/share/flexisip-account-manager
%define env_file "$RPM_BUILD_ROOT/etc/flexisip-account-manager/flexiapi.env"