FreeSWITCH Event Socket Layer (ESL) Library
FreeSWITCH's Event Socket Layer is a TCP control interface enabling the development of complex dynamic dialplans/workflows. You can learn more about its inbound mode as well as its outbound mode on the FreeSWITCH website.
This library provides an I/O agnostic implementation of the ESL protocol.
The authentication stage of an ESL connection can be summarized as follows:
/* This is a typical FreeSWITCH ESL server greeting */ $response = \RTCKit\ESL\Response::Parse("Content-Type: auth/request\n\n"); echo 'A server sends: ' . get_class($response) . PHP_EOL; /* Since we've been told to authenticate, let's prepare our auth request */ $request = \RTCKit\ESL\Request::parse("auth ClueCon\n\n"); echo 'A client responds with: ' . get_class($request) . '; '; echo 'password: ' . $request->getParameters() . PHP_EOL; /* If our secret is correct, the ESL server should confirm that */ $followup = \RTCKit\ESL\Response::parse("Content-Type: command/reply\nReply-Text: +OK accepted\n\n"); echo 'Then the server replies with: ' . get_class($followup) . '; '; echo ($followup->isSuccessful() ? 'Success!' : 'Yikes!') . PHP_EOL;
The reverse procedure, rendering to string, is straightforward:
$response = new \RTCKit\ESL\Response\AuthRequest; echo 'A server sends: "' . $response->render() . '"' . PHP_EOL; $request = new \RTCKit\ESL\Request\Auth; $request->setParameters('ClueCon'); echo 'A client responds with: "' . $request->render() . '"' . PHP_EOL; $followup = new \RTCKit\ESL\Response\CommandReply; $followup->setHeader('reply-text', '+OK accepted'); echo 'Then the server replies with: "' . $followup->render() . '"' . PHP_EOL;
Although this library is I/O independent, a Connection interface and base class are being provided; since ESL runs over TCP, a stream oriented transport, it behooves to handle the message framing in a higher level library. An implementing project would simply invoke the
ConnectionInterface::consume() method when input is available and would implement a
ConnectionInterface::emitBytes() method which performs the corresponding I/O-specific write operations.
The Connection constructor requires a
$role argument, which must be one of the following:
ConnectionInterface::INBOUND_CLIENTto be used by ESL clients connecting to FreeSWITCH ESL servers;
ConnectionInterface::OUTBOUND_SERVERto be used by ESL servers FreeSWITCH connects to in outbound mode;
The other two options are less common:
ConnectionInterface::INBOUND_SERVERto impersonate a FreeSWITCH ESL server;
ConnectionInterface::OUTBOUND_CLIENTto impersonate FreeSWITCH connecting to a remote ESL endpoint in outbound mode;
The latter two roles can be useful in test suites, implementing message relays, security research etc. Please note the inbound and outbound terms are relative to the FreeSWITCH endpoint (matching the mod_event_socket nomenclature).
RTCKit\ESL is compatible with PHP 7.4+ and has no external library and extension dependencies.
You can add the library as project dependency using Composer:
composer require rtckit/esl
If you only need the library during development, for instance when used in your test suite, then you should add it as a development-only dependency:
composer require --dev rtckit/esl
To run the test suite, clone this repository and then install dependencies via Composer:
Then, go to the project root and run:
composer phpstan composer psalm
MIT, see LICENSE file.
- FreeSWITCH, FreeSWITCH is a registered trademark of Anthony Minessale II
Bug reports (and small patches) can be submitted via the issue tracker. Forking the repository and submitting a Pull Request is preferred for substantial patches.