mirror of
https://github.com/FH-Complete/FHC-Core.git
synced 2026-06-01 20:29:29 +00:00
Paolo
d2e8b01e30
- Added new core controller core/RESTFul_Controller.php that extends REST_Controller and partially overrides part of the latter - Changed application/config/rest.php to keep the minimal useful set of configs - Controllers core/APIv1_Controller, controllers/api/v1/CheckUserAuth.php and controllers/api/v1/Test.php now extend core/RESTFul_Controller - Changed method _remap interface for core/APIv1_Controller - Removed application/core/REST_Controller.php - Removed application/libraries/Format.php - Removed application/language/english/rest_controller_lang.php
167 lines
5.1 KiB
PHP
167 lines
5.1 KiB
PHP
<?php
|
|
|
|
defined('BASEPATH') OR exit('No direct script access allowed');
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| HTTP protocol
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Set to force the use of HTTPS for REST API calls
|
|
|
|
|
*/
|
|
$config['force_https'] = TRUE;
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST Realm
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Name of the password protected REST API displayed on login dialogs
|
|
|
|
|
| e.g: My Secret REST API
|
|
|
|
|
*/
|
|
$config['rest_realm'] = 'FHC REST API';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST Login
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Set to specify the REST API requires to be logged in
|
|
|
|
|
| FALSE No login required
|
|
| 'basic' Unsecured login
|
|
| 'digest' More secured login
|
|
| 'session' Check for a PHP session variable. See 'auth_source' to set the
|
|
| authorization key
|
|
|
|
|
*/
|
|
$config['rest_auth'] = 'basic';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST Login Source
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Is login required and if so, the user store to use
|
|
|
|
|
| '' Use config based users or wildcard testing
|
|
| 'ldap' Use LDAP authentication
|
|
| 'library' Use a authentication library
|
|
|
|
|
| Note: If 'rest_auth' is set to 'session' then change 'auth_source' to the name of the session variable
|
|
|
|
|
*/
|
|
$config['auth_source'] = 'library';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST Login Class and Function
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| If library authentication is used define the class and function name
|
|
|
|
|
| The function should accept two parameters: class->function($username, $password)
|
|
| In other cases override the function _perform_library_auth in your controller
|
|
|
|
|
| For digest authentication the library function should return already a stored
|
|
| md5(username:restrealm:password) for that username
|
|
|
|
|
| e.g: md5('admin:REST API:1234') = '1e957ebc35631ab22d5bd6526bd14ea2'
|
|
|
|
|
*/
|
|
$config['auth_library_class'] = 'AuthLib';
|
|
$config['auth_library_function'] = 'basicAuthentication';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Global IP White-listing
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Limit connections to your REST server to White-listed IP addresses
|
|
|
|
|
| Usage:
|
|
| 1. Set to TRUE and select an auth option for extreme security (client's IP
|
|
| address must be in white-list and they must also log in)
|
|
| 2. Set to TRUE with auth set to FALSE to allow White-listed IPs access with no login
|
|
| 3. Set to FALSE but set 'auth_override_class_method' to 'white-list' to
|
|
| restrict certain methods to IPs in your white-list
|
|
|
|
|
*/
|
|
$config['rest_ip_whitelist_enabled'] = TRUE;
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST IP White-list
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Limit connections to your REST server with a comma separated
|
|
| list of IP addresses
|
|
|
|
|
| e.g: '123.456.789.0, 987.654.32.1'
|
|
|
|
|
| 127.0.0.1 and 0.0.0.0 are allowed by default
|
|
|
|
|
*/
|
|
$config['rest_ip_whitelist'] = '127.0.0.1';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST API Keys Table Name
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| The table name in your database that stores API keys
|
|
|
|
|
*/
|
|
$config['rest_keys_table'] = 'ci_apikey';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST Enable Keys
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| When set to TRUE, the REST API will look for a column name called 'key'.
|
|
| If no key is provided, the request will result in an error. To override the
|
|
| column name see 'rest_key_column'
|
|
|
|
|
| Default table schema:
|
|
| CREATE TABLE `keys` (
|
|
| `id` INT(11) NOT NULL AUTO_INCREMENT,
|
|
| `user_id` INT(11) NOT NULL,
|
|
| `key` VARCHAR(40) NOT NULL,
|
|
| `level` INT(2) NOT NULL,
|
|
| `ignore_limits` TINYINT(1) NOT NULL DEFAULT '0',
|
|
| `is_private_key` TINYINT(1) NOT NULL DEFAULT '0',
|
|
| `ip_addresses` TEXT NULL DEFAULT NULL,
|
|
| `date_created` INT(11) NOT NULL,
|
|
| PRIMARY KEY (`id`)
|
|
| ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
|
|
|
|
*/
|
|
$config['rest_enable_keys'] = TRUE;
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST API Key Variable
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Custom header to specify the API key
|
|
|
|
| Note: Custom headers with the X- prefix are deprecated as of
|
|
| 2012/06/12. See RFC 6648 specification for more details
|
|
|
|
|
*/
|
|
$config['rest_key_name'] = 'FHC-API-KEY';
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| REST Methods name format
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| REST Controllers methods name format
|
|
|
|
|
*/
|
|
$config['rest_methods_name_format'] = '%2$s%1$s';
|