2022-08-11 13:25:02 +02:00
|
|
|
mod_rest - HTTP interface to POST stanzas into ejabberd
|
|
|
|
|
=======================================================
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
* Requires: ejabberd 19.08 or higher
|
|
|
|
|
* Author: Nolan Eakins <sneakin@semanticgap.com>
|
|
|
|
|
* Copyright (C) 2008 Nolan Eakins
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
This is an ejabberd module that adds an HTTP handler that allows HTTP
|
|
|
|
|
clients to literally post arbitrary message stanzas to ejabberd. Those
|
|
|
|
|
stanzas then get shoved through ejabberd's router just like any other
|
|
|
|
|
stanza.
|
|
|
|
|
|
|
|
|
|
This module can also be used as a frontend to execute ejabberd commands.
|
|
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Configuration
|
|
|
|
|
-------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2022-08-12 10:52:20 +02:00
|
|
|
Configurable options:
|
|
|
|
|
|
|
|
|
|
- `allowed_ips`: IP addresses that can use the rest service.
|
|
|
|
|
Notice that the IP address is checked after the connection is established.
|
|
|
|
|
If you want to restrict the IP address that listens connections, and
|
|
|
|
|
only allow a certain IP to be able to connect to the port, then the
|
|
|
|
|
option `allowed_ips` is not useful to you: you better define the
|
|
|
|
|
listening IP address in the ejabberd listeners (see the ejabberd Guide).
|
|
|
|
|
|
|
|
|
|
- `allowed_destinations`: Allowed destination Jabber ID addresses in the stanza.
|
|
|
|
|
|
|
|
|
|
- `allowed_stanza_types`: Allowed stanza types of the posted stanza.
|
|
|
|
|
|
|
|
|
|
- `access_commands`: Access restrictions to execute ejabberd commands.
|
|
|
|
|
This option is similar to the option `ejabberdctl_access_commands` that
|
|
|
|
|
is documented in the ejabberd Guide.
|
|
|
|
|
There is more information about AccessCommands in the ejabberd Guide.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example Configuration
|
|
|
|
|
---------------------
|
|
|
|
|
|
2016-08-01 21:18:20 +02:00
|
|
|
You can modify the default module configuration file like this:
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2016-08-01 21:18:20 +02:00
|
|
|
To enable the module:
|
2022-08-11 13:25:02 +02:00
|
|
|
```yaml
|
2015-03-13 11:54:26 +01:00
|
|
|
modules:
|
|
|
|
|
mod_rest:
|
|
|
|
|
allowed_ips:
|
2016-04-11 17:19:36 +02:00
|
|
|
- "127.0.0.1"
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2016-08-01 21:18:20 +02:00
|
|
|
To enable the HTTP request handler in the listen section:
|
2022-08-11 13:25:02 +02:00
|
|
|
```yaml
|
2015-03-13 11:54:26 +01:00
|
|
|
listen:
|
2022-07-21 11:14:17 +02:00
|
|
|
-
|
2015-03-13 11:54:26 +01:00
|
|
|
port: 5285
|
|
|
|
|
module: ejabberd_http
|
|
|
|
|
request_handlers:
|
2022-07-21 11:14:17 +02:00
|
|
|
/rest: mod_rest
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
With that configuration, you can send HTTP POST requests to the URL:
|
2022-08-11 13:25:02 +02:00
|
|
|
`http://localhost:5285/rest`
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
2022-08-12 10:52:20 +02:00
|
|
|
Example Access Configuration
|
|
|
|
|
----------------------------
|
2022-08-11 13:25:02 +02:00
|
|
|
|
|
|
|
|
```yaml
|
2016-04-11 17:19:36 +02:00
|
|
|
acl:
|
|
|
|
|
restuser:
|
|
|
|
|
user:
|
|
|
|
|
- "userest": "localhost"
|
|
|
|
|
|
|
|
|
|
access:
|
|
|
|
|
restaccess:
|
|
|
|
|
restuser: allow
|
|
|
|
|
|
|
|
|
|
commands_admin_access: restaccess
|
|
|
|
|
|
|
|
|
|
modules:
|
|
|
|
|
mod_rest:
|
|
|
|
|
allowed_ips:
|
|
|
|
|
- "127.0.0.1"
|
|
|
|
|
- "192.168.1.12"
|
|
|
|
|
allowed_destinations:
|
|
|
|
|
- "nolan@localhost"
|
|
|
|
|
- "admin@example.com"
|
|
|
|
|
allowed_stanza_types:
|
|
|
|
|
- "message"
|
|
|
|
|
- "presence"
|
|
|
|
|
- "iq"
|
|
|
|
|
access_commands:
|
2019-08-19 20:42:03 +02:00
|
|
|
- restaccess:
|
2016-04-11 17:19:36 +02:00
|
|
|
- registered_users
|
|
|
|
|
- connected_users
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
This module gives many power to perform tasks in ejabberd,
|
2022-08-11 13:25:02 +02:00
|
|
|
such power in bad hands can harm your server, so you should
|
2013-04-15 12:03:14 +02:00
|
|
|
restrict the IP address that can connect to the service using:
|
2022-08-11 13:25:02 +02:00
|
|
|
a firewall, `allowed_ips option`, or the listener IP option.
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
In ejabberd 2.0.x versions,
|
|
|
|
|
it is important that the value indicated in Content-Length matches
|
|
|
|
|
exactly the size of the content.
|
|
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example ReST Call
|
|
|
|
|
-----------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
When the module receives this:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
POST /rest HTTP/1.1
|
|
|
|
|
Host: localhost
|
|
|
|
|
Content-Length: 85
|
|
|
|
|
|
|
|
|
|
<message to="nolan@localhost" from="localhost/rest"><body>World</body></message>
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
ejabberd.log shows those messages:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
=INFO REPORT==== 2-Mar-2009::11:46:05 ===
|
2018-09-05 12:07:42 +02:00
|
|
|
I(<0.484.0>:ejabberd_listener:201) : (#Port<0.3661>) Accepted connection {{127,0,0,1},55945} -> {{127,0,0,1},5285}
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
=INFO REPORT==== 2-Mar-2009::11:46:05 ===
|
|
|
|
|
I(<0.251.0>:ejabberd_http:127) : started: {gen_tcp,#Port<0.3661>}
|
|
|
|
|
|
|
|
|
|
=INFO REPORT==== 2-Mar-2009::11:46:05 ===
|
|
|
|
|
I(<0.841.0>:mod_rest:81) : Got request from localhost/rest
|
|
|
|
|
with IP {{127,0,0,1},49613}
|
|
|
|
|
to nolan@localhost:
|
|
|
|
|
{xmlelement,"message",
|
|
|
|
|
[{"to","nolan@localhost"},{"from","localhost/rest"}],
|
|
|
|
|
[{xmlelement,"body",[],[{xmlcdata,<<"World">>}]}]}
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
If the user nolan@localhost exists, he will receive this message:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
<message from='localhost/rest'
|
|
|
|
|
to='nolan@localhost'>
|
|
|
|
|
<body>World</body>
|
|
|
|
|
</message>
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
Instead of an XMPP stanza, you can provide an ejabberd command to execute:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
registered_users localhost
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
If you configure `access_commands` in `mod_rest`, you need to provide information
|
2013-04-15 12:03:14 +02:00
|
|
|
about a local Jabber account with enough privileges according to your option:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
--auth robot localhost pass0011 registered_users localhost
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example Call With Lynx
|
|
|
|
|
----------------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
This example shows how to send a POST using Lynx:
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2018-09-05 12:07:42 +02:00
|
|
|
$ lynx http://localhost:5285/rest/ -mime_header -post_data
|
2013-04-15 12:03:14 +02:00
|
|
|
<message to="nolan@localhost" from="localhost/rest"><body>World</body></message>
|
|
|
|
|
---
|
|
|
|
|
HTTP/1.0 200 OK
|
|
|
|
|
Connection: close
|
|
|
|
|
Content-Type: text/html; charset=utf-8
|
|
|
|
|
Content-Length: 2
|
|
|
|
|
|
|
|
|
|
Ok
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example Call With Wget
|
|
|
|
|
----------------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
This example shows how to send a POST using Wget:
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2018-09-05 12:07:42 +02:00
|
|
|
$ wget http://localhost:5285/rest/ --server-response --post-data '<message to="nolan@localhost" from="localhost/rest"><body>World</body></message>'
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2018-09-05 12:07:42 +02:00
|
|
|
--2009-03-02 12:01:42-- http://localhost:5285/rest/
|
2013-04-15 12:03:14 +02:00
|
|
|
Resolving localhost... 127.0.0.1
|
2018-09-05 12:07:42 +02:00
|
|
|
Connecting to localhost|127.0.0.1|:5285... connected.
|
2013-04-15 12:03:14 +02:00
|
|
|
HTTP request sent, awaiting response...
|
|
|
|
|
HTTP/1.0 200 OK
|
|
|
|
|
Connection: keep-alive
|
|
|
|
|
Content-Type: text/html; charset=utf-8
|
|
|
|
|
Content-Length: 2
|
|
|
|
|
Length: 2 [text/html]
|
|
|
|
|
Saving to: `index.html'
|
|
|
|
|
|
|
|
|
|
100%[======================================>] 2 --.-K/s in 0s
|
|
|
|
|
|
|
|
|
|
2009-03-02 12:01:42 (285 KB/s) - `index.html' saved [2/2]
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
The content of the index.html is simply:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
Ok
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Please notice that `mod_rest` and wget don't work correctly over HTTPS.
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example Auth Command With Wget
|
|
|
|
|
------------------------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
To execute an ejabberd command, simply provide its name and arguments as in ejabberdctl:
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2018-09-05 12:07:42 +02:00
|
|
|
wget http://localhost:5285/rest/ --server-response --post-data 'registered_users localhost'
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
If you configure `access_commands` option, you must provide the credentials like this:
|
|
|
|
|
```
|
2019-02-11 15:39:02 +01:00
|
|
|
wget http://localhost:5285/rest/ --server-response --post-data '--auth user1 localhost thepass registered_users localhost'
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2019-02-11 15:39:02 +01:00
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example Call With Curl
|
|
|
|
|
----------------------
|
2019-02-11 15:39:02 +01:00
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2019-02-11 15:39:02 +01:00
|
|
|
curl -X POST -i http://localhost:5285/rest/ -d 'create_room testroom muc.localhost localhost'
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: text/html; charset=utf-8
|
|
|
|
|
Content-Length: 1
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example Call With Python
|
|
|
|
|
------------------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
This example Python code first calls to send a stanza, and then calls to execute a command:
|
2022-08-11 13:25:02 +02:00
|
|
|
```python
|
2013-04-15 12:03:14 +02:00
|
|
|
import urllib2
|
|
|
|
|
|
2018-09-05 12:07:42 +02:00
|
|
|
server_url = 'http://localhost:5285/rest/'
|
2013-04-15 12:03:14 +02:00
|
|
|
|
2016-04-11 17:19:36 +02:00
|
|
|
call = '<message to="nolan@localhost" from="localhost/rest"><body>World</body></message>'
|
2013-04-15 12:03:14 +02:00
|
|
|
resp = urllib2.urlopen(server_url, call)
|
|
|
|
|
result = resp.read()
|
|
|
|
|
print result
|
|
|
|
|
|
|
|
|
|
call = 'registered_users localhost'
|
|
|
|
|
resp = urllib2.urlopen(server_url, call)
|
|
|
|
|
result = resp.read()
|
|
|
|
|
print result
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
2022-08-11 13:25:02 +02:00
|
|
|
Example Call With PHP
|
|
|
|
|
---------------------
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
This example PHP code implements a call to execute a command (thanks to Qu1cksand):
|
2022-08-11 13:25:02 +02:00
|
|
|
```php
|
2013-04-15 12:03:14 +02:00
|
|
|
<?
|
|
|
|
|
function sendRESTRequest ($url, $request) {
|
|
|
|
|
// Create a stream context so that we can POST the REST request to $url
|
|
|
|
|
$context = stream_context_create (array ('http' => array ('method' => 'POST'
|
2018-09-05 12:07:42 +02:00
|
|
|
,'header' => "Host: localhost:5285\nContent-Type: text/html; charset=utf-8\nContent-Length: ".strlen($request)
|
2013-04-15 12:03:14 +02:00
|
|
|
,'content' => $request)));
|
|
|
|
|
// Use file_get_contents for PHP 5+ otherwise use fopen, fread, fclose
|
|
|
|
|
if (version_compare(PHP_VERSION, '5.0.0', '>=')) {
|
|
|
|
|
$result = file_get_contents($url, false, $context);
|
|
|
|
|
} else {
|
|
|
|
|
// This is the PHP4 workaround which is slightly less elegant
|
|
|
|
|
// Suppress fopen warnings, otherwise they interfere with the page headers
|
|
|
|
|
$fp = @fopen($url, 'r', false, $context);
|
|
|
|
|
$result = '';
|
|
|
|
|
// Only proceed if we have a file handle, otherwise we enter an infinite loop
|
|
|
|
|
if ($fp) {
|
|
|
|
|
while(!feof($fp)) {
|
|
|
|
|
$result .= fread($fp, 4096);
|
|
|
|
|
}
|
|
|
|
|
fclose($fp);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return $result;
|
|
|
|
|
}
|
2018-09-05 12:07:42 +02:00
|
|
|
$url = "http://localhost:5285/rest";
|
2013-04-15 12:03:14 +02:00
|
|
|
$request = "register user12 localhost somepass";
|
|
|
|
|
$response = sendRESTRequest($url, $request);
|
|
|
|
|
echo "Response: $response\n";
|
|
|
|
|
?>
|
2022-08-11 13:25:02 +02:00
|
|
|
```
|
