policyd-rate-limit(8)

💖 NAME 💖

okay so bestie, meet policyd-rate-limit — she's a rate limiter SMTP policy daemon and she is literally the moment. 🎀

---

✨ SYNOPSIS ✨

policyd-rate-limit [-h] [--clean] [--get-config configname] [--file
configpath]

---

🦋 DESCRIPTION 🦋

policyd-rate-limit(8) is an SMTP policy daemon written in python3(1) for postfix(1). No cap. 💅

She keeps track of how many mails each sasl username and/or ip address has sent, over a time sliding window. And then — the way that she will notice — once a user and/or ip address exceeds one or more configurable limits, a configurable action gets done (peep access(5) for that action tea). periodt.

---

🌸 SETUP 🌸

so like, for postfix 3.0 and later, you can set this in your postfix /etc/postfix/main.cf configuration file:

smtpd_data_restrictions =
  ...,
  check_policy_service { unix:ratelimit/policy, default_action=DUNNO },
  ...

Postfix will ask policyd-rate-limit what to do on mail reception (that's the success or fail action bestie) and — iconic behaviour — it will accept the mail if policyd-rate-limit becomes unavailable. 🫶

On previous postfix versions, you must use:

smtpd_data_restrictions =
  ...,
  check_policy_service unix:ratelimit/policy,
  ...

---

💜 OPTIONS 💜

• -h, --help — show this help message and exit. slay, she's helpful ✨
• --clean — clean old records from the database 🧹
• --get-config configname — return the value of the configname configuration parameter. You can get a value in a dictionary by using a dotted notation. For instance, for getting the key KEY in the dictionary DICT, you should use DICT.KEY for configname. You can call the configuration parameter config_file to know which configuration file is used. 👑
• -f, --file — path to a policyd-rate-limit configuration file 🍓

---

🌈 LOGGING 🌈

Logging is output to stderr and redirected to syslog(3) by systemd. Logs are produced only if the debug configuration parameter is set to True. no debug, no gossip 💀

---

🎀 CONFIGURATION 🎀

If the option --file is not specified, policyd-rate-limit(8) tries to read its configuration from the following path and chooses the first existing file:

~/.config/policyd-rate-limit.conf
~/.config/policyd-rate-limit.yaml
/etc/policyd-rate-limit.conf
/etc/policyd-rate-limit.yaml

The .conf are the old configuration format. It was a python module and should not be used. 🙈 The .yaml are the new configuration format using the YAML syntax. See YAML(3pm) for an overview of the format. See policyd-rate-limit.yaml(5) for possible settings, bestie, go read it. 💖

---

⭐ EXIT VALUES ⭐

• 0 — Normal exit. 🥰
• 1 — Only return then the option --get-config is used. Configuration parameter not found. 😭
• 2 — User or group set in the configuration file do not exists.
• 3 — Another instance is already running. bestie she's already there 💅
• 4 — The configuration parameter SOCKET is malformed.
• 5 — Configuration file not found.
• 6 — Some error was raised during runtime.
• 8 — Error during cleaning.

---

🔥 SEE ALSO 🔥

• policyd-rate-limit.yaml(5): policyd-rate-limit configuration file
• master(5), Postfix master.cf file syntax
• access(5), Postfix SMTP access control table

---

👑 AUTHOR 👑

Valentin Samir <valentin.samir@crans.org>

title_upper: policyd-rate-limit

---

💅 COPYRIGHT 💅

GPL-3

---

okay that's the whole thing bestie, you ate. and for the record, this little beauty is version 3.8, dated 2016-08-04, and she answers to policyd-rate-limit(8) 🦋✨🎀