tourze/json-rpc-check-ip-bundle

JsonRPC IP检查

0.0.2 2025-04-15 16:04 UTC

Requires

• php: ^8.1
• psr/log: ^3|^2|^1
• symfony/config: ^6.4
• symfony/dependency-injection: ^6.4
• symfony/framework-bundle: ^6.4
• symfony/http-foundation: ^6.4
• symfony/http-kernel: ^6.4
• symfony/stopwatch: ^6.4
• tourze/doctrine-helper: 0.0.*
• tourze/json-rpc-core: ^0.0.6

Requires (Dev)

• phpstan/phpstan: ^2.1

MIT

README

English | 中文

A Symfony bundle that provides IP checking for JsonRPC server-to-server interfaces. By annotating your service classes, you can restrict access to specific IP ranges using environment variable configuration.

Features

• Restrict JsonRPC method access by client IP
• Simple attribute-based configuration (CheckIp Attribute)
• Environment variable driven IP whitelist
• Easy integration with Symfony and JsonRPC-Core

Installation

composer require tourze/json-rpc-check-ip-bundle

Quick Start

1. Configure allowed IPs in your environment variables (e.g., .env):

ALLOWED_RPC_IPS=127.0.0.1,192.168.1.0/24

1. Annotate your service class with the CheckIp attribute:

use Tourze\JsonRPCCheckIPBundle\Attribute\CheckIp;

#[CheckIp(envKey: 'ALLOWED_RPC_IPS')]
class MyRpcService
{
    // ...
}

When a JsonRPC call is made, the bundle will check if the client's IP is within the allowed range. If not, an exception is thrown.

Configuration

• envKey: The environment variable key used to read the allowed IP list (comma separated, supports CIDR).

Advanced

• Integrates with Symfony's RequestStack and IpUtils for robust IP matching.
• Only methods/classes annotated with CheckIp are protected.
• If no IPs are configured, all requests are allowed by default.

Contributing

Contributions are welcome! Please submit issues or pull requests. Make sure your code passes tests and follows the project's coding standards.

License

This bundle is open-sourced software licensed under the MIT license.

Changelog

See CHANGELOG for version history and upgrade notes.