————-revisar agregar cosas————–
Documentación de la API I2PControl
I2PControl es una API JSON-RPC 2.0 incluida con el router I2P (desde la versión 0.9.39). Permite el monitoreo y control autenticado del router a través de solicitudes JSON estructuradas.
Contraseña por defecto:
itoopie— esta es la configuración de fábrica y debe cambiarse inmediatamente por seguridad.
1. Descripción general y acceso
| Implementation | Default Endpoint | Protocol | Enabled by Default | Notes |
|---|---|---|---|---|
| Java I2P (2.10.0+) | http://127.0.0.1:7657/jsonrpc/ | HTTP | ❌ Must be enabled via WebApps (Router Console) | Bundled webapp |
| i2pd (C++ implementation) | https://127.0.0.1:7650/ | HTTPS | ✅ Enabled by default | Legacy plugin behavior |
2. Formato JSON-RPC
Todas las solicitudes siguen la estructura JSON-RPC 2.0:
{
"jsonrpc": "2.0",
"id": "1",
"method": "MethodName",
"params": {
/* named parameters */
}
}
Una respuesta exitosa incluye un campo result; en caso de fallo, se devuelve un objeto error:
{
"jsonrpc": "2.0",
"id": "1",
"result": { /* data */ }
}
o
{
"jsonrpc": "2.0",
"id": "1",
"error": {
"code": -32001,
"message": "Invalid password"
}
}
3. Flujo de Autenticación
Solicitud (Autenticar)
curl -s -H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": "1",
"method": "Authenticate",
"params": {
"API": 1,
"Password": "itoopie"
}
}' \
http://127.0.0.1:7657/jsonrpc/
Respuesta Exitosa
{
"jsonrpc": "2.0",
"id": "1",
"result": {
"Token": "a1b2c3d4e5",
"API": 1
}
}
Debes incluir ese Token en todas las solicitudes posteriores en los params.
4. Métodos y Endpoints
4.1 RouterInfo
Obtiene telemetría clave sobre el router.
Ejemplo de Solicitud
curl -s -H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": "2",
"method": "RouterInfo",
"params": {
"Token": "a1b2c3d4e5",
"i2p.router.version": "",
"i2p.router.status": "",
"i2p.router.net.status": "",
"i2p.router.net.tunnels.participating": "",
"i2p.router.net.bw.inbound.1s": "",
"i2p.router.net.bw.outbound.1s": ""
}
}' \
http://127.0.0.1:7657/jsonrpc/
Campos de Respuesta (result) Según la documentación oficial (GetI2P): - i2p.router.status (String) — un estado legible por humanos - i2p.router.uptime (long) — milisegundos (o string para i2pd más antiguo) :contentReference[oaicite:0]{index=0} - i2p.router.version (String) — cadena de versión :contentReference[oaicite:1]{index=1} - i2p.router.net.bw.inbound.1s, i2p.router.net.bw.inbound.15s (double) — ancho de banda entrante en B/s :contentReference[oaicite:2]{index=2} - i2p.router.net.bw.outbound.1s, i2p.router.net.bw.outbound.15s (double) — ancho de banda saliente en B/s :contentReference[oaicite:3]{index=3} - i2p.router.net.status (long) — código de estado numérico (ver enumeración a continuación) :contentReference[oaicite:4]{index=4} - i2p.router.net.tunnels.participating (long) — número de tunnels participantes :contentReference[oaicite:5]{index=5} - i2p.router.netdb.activepeers, fastpeers, highcapacitypeers (long) — estadísticas de peers del netDB :contentReference[oaicite:6]{index=6} - i2p.router.netdb.isreseeding (boolean) — si el reseed está activo :contentReference[oaicite:7]{index=7} - i2p.router.netdb.knownpeers (long) — total de peers conocidos :contentReference[oaicite:8]{index=8}
Enumeración de Códigos de Estado (i2p.router.net.status)
| Code | Meaning |
|---|---|
| 0 | OK |
| 1 | TESTING |
| 2 | FIREWALLED |
| 3 | HIDDEN |
| 4 | WARN_FIREWALLED_AND_FAST |
| 5 | WARN_FIREWALLED_AND_FLOODFILL |
| 6 | WARN_FIREWALLED_WITH_INBOUND_TCP |
| 7 | WARN_FIREWALLED_WITH_UDP_DISABLED |
| 8 | ERROR_I2CP |
| 9 | ERROR_CLOCK_SKEW |
| 10 | ERROR_PRIVATE_TCP_ADDRESS |
| 11 | ERROR_SYMMETRIC_NAT |
| 12 | ERROR_UDP_PORT_IN_USE |
| 13 | ERROR_NO_ACTIVE_PEERS_CHECK_CONNECTION_AND_FIREWALL |
| 14 | ERROR_UDP_DISABLED_AND_TCP_UNSET |
4.2 GetRate
Se utiliza para obtener métricas de velocidad (por ejemplo, ancho de banda, éxito de tunnel) durante una ventana de tiempo determinada.
Ejemplo de Solicitud
curl -s -H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": "3",
"method": "GetRate",
"params": {
"Token": "a1b2c3d4e5",
"Stat": "bw.combined",
"Period": 60000
}
}' \
http://127.0.0.1:7657/jsonrpc/
Respuesta de Ejemplo
{
"jsonrpc": "2.0",
"id": "3",
"result": {
"Rate": 12345.67
}
}
4.3 RouterManager
Realizar acciones administrativas.
Parámetros / métodos permitidos - Restart, RestartGraceful - Shutdown, ShutdownGraceful - Reseed, FindUpdates, Update :contentReference[oaicite:10]{index=10}
Ejemplo de Solicitud
curl -s -H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": "4",
"method": "RouterManager",
"params": {
"Token": "a1b2c3d4e5",
"Restart": true
}
}' \
http://127.0.0.1:7657/jsonrpc/
Respuesta Exitosa
{
"jsonrpc": "2.0",
"id": "4",
"result": {
"Restart": null
}
}
4.4 NetworkSetting
Obtener o establecer parámetros de configuración de red (puertos, upnp, ancho de banda compartido, etc.)
Ejemplo de Solicitud (obtener valores actuales)
curl -s -H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": "5",
"method": "NetworkSetting",
"params": {
"Token": "a1b2c3d4e5",
"i2p.router.net.ntcp.port": null,
"i2p.router.net.ssu.port": null,
"i2p.router.net.bw.share": null,
"i2p.router.net.upnp": null
}
}' \
http://127.0.0.1:7657/jsonrpc/
Respuesta de Ejemplo
{
"jsonrpc": "2.0",
"id": "5",
"result": {
"i2p.router.net.ntcp.port": "1234",
"i2p.router.net.ssu.port": "5678",
"i2p.router.net.bw.share": "50",
"i2p.router.net.upnp": "true",
"SettingsSaved": true,
"RestartNeeded": false
}
}
Nota: las versiones de i2pd anteriores a la 2.41 pueden devolver tipos numéricos en lugar de cadenas — los clientes deben manejar ambos. :contentReference[oaicite:11]{index=11}
4.5 Configuración Avanzada
Permite manipular parámetros internos del router.
Ejemplo de Solicitud
curl -s -H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": "6",
"method": "AdvancedSettings",
"params": {
"Token": "a1b2c3d4e5",
"Set": {
"router.sharePercentage": "75",
"i2np.flushInterval": "6000"
}
}
}' \
http://127.0.0.1:7657/jsonrpc/
Ejemplo de Respuesta
{
"jsonrpc": "2.0",
"id": "6",
"result": {
"Set": {
"router.sharePercentage": "75",
"i2np.flushInterval": "6000"
}
}
}
5. Códigos de Error
Códigos de Error Estándar JSON-RPC2
| Code | Meaning |
|---|---|
| -32700 | JSON parse error |
| -32600 | Invalid request |
| -32601 | Method not found |
| -32602 | Invalid parameters |
| -32603 | Internal error |
| Code | Meaning |
|---|---|
| -32001 | Invalid password provided |
| -32002 | No authentication token presented |
| -32003 | Authentication token doesn't exist |
| -32004 | The provided authentication token was expired and will be removed |
| -32005 | The version of the I2PControl API used wasn't specified, but is required to be specified |
| -32006 | The version of the I2PControl API specified is not supported by I2PControl |
6. Uso y mejores prácticas
- Incluye siempre el parámetro
Token(excepto al autenticarse). - Cambia la contraseña predeterminada (
itoopie) en el primer uso. - Para Java I2P, asegúrate de que la webapp I2PControl esté habilitada a través de WebApps.
- Prepárate para ligeras variaciones: algunos campos pueden ser números o cadenas, dependiendo de la versión de I2P.
- Envuelve las cadenas de estado largas para obtener una salida amigable para la visualización.