NCIDD.WHITELIST(5)

💖 NCIDD.WHITELIST(5) 💖

okay bestie, so this is the manual page for ncidd.whitelist — the whitelist file for ncidd hangup — and it's part of the NCID manual set. grab a snack, we're going in 🍓

---

✨ NAME ✨

ncidd.whitelist — the whitelist file for ncidd hangup. literally that's her whole job 💅

---

🌸 DESCRIPTION 🌸

so the ncidd.whitelist file is where you keep the expressions that get matched against a telephone call's name or number. that's it, that's the vibe.

here's the tea though: if the hangup option is set, and there's no match in the whitelist file, then a match in the blacklist file will cause ncidd to automatically terminate the call. so like… the whitelist is your girl's get-out-of-jail-free card 🫶 no match here + a blacklist match = call ends, periodt.

the ncidd.whitelist file understands 4 types of lines:

• blank line: skip it 🙈
• comment line: skip it 💤
• entry line: process it 🔥

entry lines contain one or more expressions and an optional comment. an expression is either a string of non-blank characters, or everything between double quotes. multiple expressions are separated by spaces. and a comment must be last — no sneaking it in the middle, bestie.

entry line comments come in two flavors: normal comments and match name comments.

a normal comment begins with a '#' and must not be immediately followed by an equals sign. anything after the '#' is ignored, bye 👋

a match name comment begins with '#=' and is followed by a name to display for the caller when the entry matches either the number or name of a call. do not use double quotes around the name, okay? just don't 💀

example:

ncidd.blacklist: ^999         #= Unwanted Area code
ncidd.whitelist: 9995550000   #= WHT (999) 555-0000

---

🦋 NOTES 🦋

each expression is compared to the caller name and number.

upper and lower case letters are significant — so yes, capitalization matters, this is not a lowercase-free-for-all.

the number must be a string of digits as they appear in /var/log/cidcall.log.

a leading '1' is required if it is in /var/log/cidcall.log.

a partial name or number can match. iconic.

🌈 If Simple expressions are used (regex = 0)

NCID Simple Expression Syntax

• a partial name or number can match. 1234 will match any of 6312346600 or 6311234600 or 6312123460
• a '^' at the beginning an expression means it must match at the start of a name or number
• a "^1?" at the beginning makes a leading 1 optional, and is only needed when using the '^' the beginning of the number. this is only useful for US numbers.
• a '$' at the end of an expression means it must match at the end of a name or number. " FL$" matches "MIAMI FL"
• a single '*' matches anything.
• upper and lower case letters are significant.
• if an expression is longer than the name or number, it will never match.

💜 If POSIX regular expressions are used (regex = 1)

POSIX Extended Regular Expression Syntax

https://en.wikipedia.org/wiki/Regular_expression

Introduction to Regular Expressions

http://www.regular-expressions.info/quickstart.html

🎀 If Perl Compatible Regular Expressions (PCRE) are used (regex = 2)

Perl regular expressions man page

https://perldoc.perl.org/perlre

pcre2syntax man page

https://www.pcre.org/current/doc/html/pcre2syntax.html

⭐ Simple and Regular Expressions

• a '^' at the beginning of an expression means it must match at the start of a name or number.
• a "^1?" at the beginning makes a leading 1 optional. this is only useful for US/Canadian numbers.
• if an expression is longer than the name or number field it will never match.

---

💅 EXAMPLES 💅

blacklist the unassigned 999 area code with and without a leading 1, but allow a call from 999-555-1212:

ncidd.blacklist: ^1?999
ncidd.whitelist: 9995551212

whitelist expression for an optional leading 1 (US/Canada only):

^1?9995551212

---

👑 SEE ALSO 👑

ncidd.8, ncidd.conf.5, ncidd.alias.5, ncidd.blacklist.5

---

that's the whole page, bestie, you ate it up 🫶 this was NCID, dated 2024-06-23 — go forth and whitelist responsibly, mwah 💖✨🎀