1. greydb(8)
  2. greydb(8)

NAME

greydb - greyd database tool

SYNOPSIS

greydb [-f config] [[-TDt] -a keys] [[-TDt] -d keys] [-Y synctarget]

DESCRIPTION

greydb manipulates the greyd database used for greyd(8).

The options are as follows:

-f config

The main greyd configuration file.

-a keys

Add or update the entries for keys. This can be used to whitelist one or more IP addresses (i.e. circumvent the greylisting process altogether) by adding all IP addresses as keys to the greyd database for WHITE entries. If any keys specified match entries already in the greyd database, greydb updates the entry's time last seen to now.

-d keys

Delete entries for keys.

-T

Add or delete the keys as SPAMTRAP entries. See the GREYTRAPPING section of greyd(8) for more information. Must be used in conjunction with the -a or -d option.

-D

Add or delete the keys as permitted DOMAIN entries. See the GREYTRAPPING section of greyd(8) for more information. Must be used in conjunction with the -a or -d option.

-t

Add or delete the keys as TRAPPED entries. See the GREYTRAPPING section of greyd(8) for more information. Must be used in conjunction with the -a or -d option.

-Y synctarget

Add a target to receive synchronisation messages; see SYNCHRONISATION below. This option can be specified multiple times.

If adding or deleting a SPAMTRAP address (-T), keys should be specified as email addresses:

spamtrap@mydomain.org

If adding or deleting a DOMAIN entries (-D), keys should be specified as domains/email addresses:

allowed-domain.org
@another-allowed-domain.org
individual@greyd.org

Otherwise keys must be numerical IP addresses.

DATABASE OUTPUT FORMAT

If invoked without any arguments, greydb lists the contents of the database in a text format.

For SPAMTRAP and DOMAIN entries the format is:

type|mailaddress

where type will be SPAMTRAP and mailaddress will be the email address for which any connections received by greyd(8) will be blacklisted if mail is sent to this address.

For TRAPPED entries the format is:

type|ip|expire

where type will be TRAPPED, IP will be the IP address blacklisted due to hitting a spamtrap, and expire will be when the IP is due to be removed from the blacklist.

For GREY entries, the format is:

type|source IP|helo|from|to|first|pass|expire|block|pass

For WHITE entries, the format is:

type|source IP|||first|pass|expire|block|pass

The fields are as follows:

type

WHITE if whitelisted or GREY if greylisted

source IP

IP address the connection originated from

helo

what the connecting host sent as identification in the HELO/EHLO command in the SMTP dialogue

from

envelope-from address for GREY (empty for WHITE entries)

to

envelope-to address for GREY (empty for WHITE entries)

first

time the entry was first seen

pass

time the entry passed from being GREY to being WHITE

expire

time the entry will expire and be removed from the database

block

number of times a corresponding connection received a temporary failure from greyd(8)

pass

number of times a corresponding connection has been seen to pass to the real MTA by greylogd(8)

Note that times are in seconds since the Epoch, in the manner returned by time(3). Times may be converted to human readable format using:

$ date --date '@<value>'

SYNCHRONISATION

greydb supports realtime synchronisation of added entries by sending the information it updates to a number of greyd(8) daemons running on multiple machines. To enable synchronisation, use the command line option -Y to specify the machines to which greydb will send messages. The synchronisation may also be configured entirely via greyd.conf(5). For more information, see greyd(8) and greyd.conf(5).

greydb only sends sync messages for additions/deletions of WHITE & TRAPPED entries only.

greydb is Copyright (C) 2015 Mikey Austin (greyd.org)

SEE ALSO

greyd.conf(5), greyd-setup(8), greyd(8), greylogd(8)

CREDITS

Much of this man page was taken from the OpenBSD manual, and adapted accordingly.

  1. May 2016
  2. greydb(8)