Add httpapi password change driver to connect to generic HTTP/HTTPS APIs
David Croft
4 years ago
parent
98881a0cbd
commit
48da92765f
@ -0,0 +1,156 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Roundcube password driver for generic HTTP APIs.
|
||||||
|
*
|
||||||
|
* This driver changes the e-mail password via any generic HTTP/HTTPS API.
|
||||||
|
* Requires curl PHP module.
|
||||||
|
*
|
||||||
|
* @author David Croft
|
||||||
|
*
|
||||||
|
* Copyright (C) The Roundcube Dev Team
|
||||||
|
*
|
||||||
|
* Config variables:
|
||||||
|
* $config['password_httpapi_url'] = 'https://passwordserver.example.org'; // required
|
||||||
|
* $config['password_httpapi_method'] = 'POST'; // default
|
||||||
|
* $config['password_httpapi_ssl_verify'] = true; // default
|
||||||
|
* $config['password_httpapi_var_user'] = 'user'; // optional
|
||||||
|
* $config['password_httpapi_var_curpass'] = 'curpass'; // optional
|
||||||
|
* $config['password_httpapi_var_newpass'] = 'newpass'; // optional
|
||||||
|
* $config['password_httpapi_expect'] = '/^ok$/i'; // optional
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see http://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
|
||||||
|
class rcube_httpapi_password
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* This method is called from roundcube to change the password
|
||||||
|
*
|
||||||
|
* roundcube already validated the old password so we just need to change it at this point
|
||||||
|
*
|
||||||
|
* @author David Croft
|
||||||
|
* @param string $curpass Current password
|
||||||
|
* @param string $newpass New password
|
||||||
|
* @param string $username Login username
|
||||||
|
* @returns int PASSWORD_SUCCESS|PASSWORD_ERROR|PASSWORD_CONNECT_ERROR
|
||||||
|
*/
|
||||||
|
function save($curpass, $newpass, $username)
|
||||||
|
{
|
||||||
|
// Get configuration with defaults
|
||||||
|
|
||||||
|
$rcmail = rcmail::get_instance();
|
||||||
|
|
||||||
|
$url = $rcmail->config->get('password_httpapi_url');
|
||||||
|
$method = $rcmail->config->get('password_httpapi_method', 'POST');
|
||||||
|
$ssl_verify = $rcmail->config->get('password_httpapi_ssl_verify', true);
|
||||||
|
$var_user = $rcmail->config->get('password_httpapi_var_user');
|
||||||
|
$var_curpass = $rcmail->config->get('password_httpapi_var_curpass');
|
||||||
|
$var_newpass = $rcmail->config->get('password_httpapi_var_newpass');
|
||||||
|
$expect = $rcmail->config->get('password_httpapi_expect');
|
||||||
|
|
||||||
|
// Initialise curl options
|
||||||
|
|
||||||
|
$curl = curl_init();
|
||||||
|
|
||||||
|
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT , 5);
|
||||||
|
if ($ssl_verify) {
|
||||||
|
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST , 2);
|
||||||
|
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER , true);
|
||||||
|
} else {
|
||||||
|
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST , 0);
|
||||||
|
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER , false);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set the variables on the GET query string or POST vars
|
||||||
|
|
||||||
|
$vars = array();
|
||||||
|
if ($var_user) $vars[$var_user] = $username;
|
||||||
|
if ($var_curpass) $vars[$var_curpass] = $curpass;
|
||||||
|
if ($var_newpass) $vars[$var_newpass] = $newpass;
|
||||||
|
|
||||||
|
if ($method == 'POST') {
|
||||||
|
curl_setopt($curl, CURLOPT_POST, 1);
|
||||||
|
curl_setopt($curl, CURLOPT_POSTFIELDS, $vars);
|
||||||
|
} elseif ($method == 'GET') {
|
||||||
|
$query = http_build_query($vars);
|
||||||
|
if (parse_url($url, PHP_URL_QUERY)) { // Does URL already include a query string?
|
||||||
|
$url .= '&' . $query;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$url .= '?' . $query;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
rcube::raise_error(array(
|
||||||
|
'code' => 600,
|
||||||
|
'type' => 'php',
|
||||||
|
'file' => __FILE__, 'line' => __LINE__,
|
||||||
|
'message' => "Password plugin: Invalid httpapi method"
|
||||||
|
), true, false);
|
||||||
|
|
||||||
|
return PASSWORD_CONNECT_ERROR;
|
||||||
|
}
|
||||||
|
|
||||||
|
curl_setopt($curl, CURLOPT_URL , $url);
|
||||||
|
curl_setopt($curl, CURLOPT_RETURNTRANSFER , true);
|
||||||
|
|
||||||
|
// Execute the query and check the results
|
||||||
|
|
||||||
|
$result = curl_exec($curl);
|
||||||
|
|
||||||
|
if ($result === false) {
|
||||||
|
rcube::raise_error(array(
|
||||||
|
'code' => 600,
|
||||||
|
'type' => 'php',
|
||||||
|
'file' => __FILE__, 'line' => __LINE__,
|
||||||
|
'message' => "Password plugin: Failed to exec curl: " . curl_error($curl)
|
||||||
|
), true, false);
|
||||||
|
|
||||||
|
return PASSWORD_CONNECT_ERROR;
|
||||||
|
}
|
||||||
|
|
||||||
|
$response_code = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
|
||||||
|
|
||||||
|
curl_close($curl);
|
||||||
|
|
||||||
|
// Non-2xx response codes mean the password change failed
|
||||||
|
|
||||||
|
if ($response_code < 200 || $response_code > 299) {
|
||||||
|
rcube::raise_error(array(
|
||||||
|
'code' => 600,
|
||||||
|
'type' => 'php',
|
||||||
|
'file' => __FILE__, 'line' => __LINE__,
|
||||||
|
'message' => "Password plugin: Unexpected response code ${response_code}: \"" . substr($result, 0, 1024) . "\""
|
||||||
|
), true, false);
|
||||||
|
|
||||||
|
return ($response_code == 404 || $response_code > 499) ? PASSWORD_CONNECT_ERROR : PASSWORD_ERROR;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If configured, check the body of the response
|
||||||
|
|
||||||
|
if ($expect && !preg_match($expect, $result)) {
|
||||||
|
rcube::raise_error(array(
|
||||||
|
'code' => 600,
|
||||||
|
'type' => 'php',
|
||||||
|
'file' => __FILE__, 'line' => __LINE__,
|
||||||
|
'message' => "Password plugin: Expected success message was not received, got \"" . substr($result, 0, 1024) . "\""
|
||||||
|
), true, false);
|
||||||
|
|
||||||
|
return PASSWORD_ERROR;
|
||||||
|
}
|
||||||
|
|
||||||
|
return PASSWORD_SUCCESS;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
Loading…
Reference in New Issue