Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/madpilot78/freeboxphp
PHP library to access FreeBox Routers
https://github.com/madpilot78/freeboxphp
api freebox php
Last synced: about 2 months ago
JSON representation
PHP library to access FreeBox Routers
- Host: GitHub
- URL: https://github.com/madpilot78/freeboxphp
- Owner: madpilot78
- License: bsd-3-clause
- Created: 2024-04-28T15:15:35.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T17:00:15.000Z (4 months ago)
- Last Synced: 2024-11-04T10:51:34.047Z (2 months ago)
- Topics: api, freebox, php
- Language: PHP
- Homepage:
- Size: 177 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# FreeBox PHP
[](https://packagist.org/packages/madpilot78/freebox-php)
[](https://github.com/madpilot78/FreeBoxPHP/actions/workflows/tests.yml)
[](https://codecov.io/github/madpilot78/FreeBoxPHP)
This is a small and simple PHP library to interface with Iliad FreeBox
(IliadBox for the Italian market) provided broadband routers.
## Install
Using composer:
```sh
composer require madpilot78/FreeBoxPHP
```
## Requirements
This project works with PHP 8.3 and upper.
## Library description
I'm writing this library for my own needs. It handles discovery and
authentication and then exposes some router APIs via methods.
For a list of implemented methods look in `src/Methods`.
NOTE: Since I'm in Italy I have tested this only with my router, an
IliadBox (Italian version), configured with self provided certificate.
If you have a different setup and have problems, please contact me
and maybe I can update the library to work with more setups.
### NOTE
For documentation on each API specifics please check your OpenBox/IliadBox
developer documentation, accessible through the WebUI.
## How to use
There is a Configuration object that can be used to customize the library.
First one needs to register with the Box, for example:
```php
use madpilot78\FreeBoxPHP\Configuration;
use madpilot78\FreeBoxPHP\Box;
use madpilot78\FreeBoxPHP\Enum\BoxType;
$config = new Configuration(
hostname: 'box.example.org',
boxType: BoxType::Iliad,
certFile: null,
);
$box = new Box(configuration: $config);
$token = $box->discover()->register(quiet: false);
echo $token . PHP_EOL;
```
(check the FreeBox/IliadBox display to authorize the client)
Once the client ha been authorized its permissions can be configured in
the FreeBox/IliadBox UI.
With the token it is possible to access the full functionality.
For example to display IPv6 configuration:
```php
use madpilot78\FreeBoxPHP\Configuration;
use madpilot78\FreeBoxPHP\Box;
use madpilot78\FreeBoxPHP\Enum\BoxType;
$config = new Configuration(
hostname: 'box.example.org',
boxType: BoxType::Iliad,
certFile: null,
);
$box = new Box(authToken: '', configuration: $config);
$ret = $box->discover()->connectionIPv6Configuration('get');
var_dump($ret);
```
(NOTE: `discover()` needs to be called only once per instance, results are cached
in the instance)
The IPv6 firewall can be turned on with (this API will also return the new configuration):
```php
$ret = $box->connectionIPv6Configuration(set', ['ipv6_firewall' => true]);
var_dump($ret);
```
APIs requiring an ID take it as an argument, for example to fetch an existing redirect:
```php
$ret = $box->fwRedir('get', 1));
var_dump($ret);
```
And a disable redirect can be modified (for example enabled) like this:
```php
$ret = $box->fwRedir('update', 1, ['enabled' => true]));
var_dump($ret);
```
## Implemented APIs
- Discover
- Register
- Login/Logout (login performed automatically if needed)
- Language (changing the language may not work, I suspect this is a
restriction on my IliadBox)
- ConnectionConfiguration
- ConnectionIPv6Configuration
- ConnectionStatus (r/o)