| Methods |
public
|
__construct()
|
#
|
public
|
is_banned(string|null $ip = null, string|null $jail = null): bool
Authenticated client IP or $ip is banned
Authenticated client IP or $ip is banned
Parameters
| $jail |
optional jail to check
|
|
#
|
public
|
banned_services(string $ip = null): array
Get services for which IP is banned
Get services for which IP is banned
|
#
|
public
|
get_reason(string|null $ip = null, string|null $jail = null): string|null
Get reason for ban
|
#
|
public
|
ban(string $ip, string $jail): bool
Disallow an IP address from service
Disallow an IP address from service
|
#
|
public
|
temp(string $ip = null, int $duration = 7200): bool
Temporarily whitelist an IP
Temporarily whitelist an IP
|
#
|
public
|
whitelist(string|null $ip = null, string $mode = 'add'): bool
Whitelist IP acccess
Parameters
| $ip |
whitelist named or present IP
|
|
#
|
public
|
can_delegate(): bool
Account supports delegation abilities
Account supports delegation abilities
|
#
|
public
|
max_delegations(): int|null
Get maximum number of delegated entries
Get maximum number of delegated entries
|
#
|
public
|
enabled(): bool
Rampart service enabled
|
#
|
public
|
get_delegated_list(): array
Return a list of delegated whitelist entries
Return a list of delegated whitelist entries
|
#
|
public
|
get_plist(string $list): array|bool
Get permanent list entries
Get permanent list entries
Parameters
| $list |
"blacklist" or "whitelist"
|
|
#
|
public
|
get_jail_entries(string $jail): array|bool
Get jail entries
Returns
array or false on failure
|
#
|
public
|
flush(string|null $jail = null): bool
Flush jails
|
#
|
public
|
blacklist(string $ip, string $mode = 'add'): bool
Permanently block access
Parameters
| $mode |
add, remove, or set
|
|
#
|
public
|
get_jails(): array
Get active jails
|
#
|
public
|
unban(string|null $ip = null, string|null $jail = null): bool
Unban an IP address
Parameters
| $jail |
optional jail to remove
|
|
#
|
public
|
bans_since(int $begin, int|null $end = null, array|null $jails = null): array
Get ban counts for each jail
Get ban counts for each jail
Parameters
| $begin |
begin ts inclusive
|
| $end |
end ts exclusive
|
| $jails |
restrict to jails
|
|
#
|
public
|
_cron(Cronus $cron)
|
#
|
public
|
_housekeeping()
|
#
|