michaldudek/subdomain-blacklist

Common words that your users shouldn't use when setting up accounts.

Subdomain Blacklist

List of common words that your users shouldn't use when setting up accounts., _(*1)

, _(*2)

When your app or service allows users to access their accounts using subdomains, e.g. michaldudek.myapp.com, it is useful to block some words so they don't take away a subdomain you'd want to use in the future or worse, try to trick your other users into believing they represent you (e.g. legal.myapp.com or support.myapp.com)., _(*3)

Apart from the blacklist, the goal of this repository is to provide code in various languages that validates a username against the list., _(*4)

Note that the goal of this library IS NOT to validate domain name. You still have to check whether or not the given username makes a valid subdomain., _(*5)

Acknowledgement

The idea and the list was originally taken from Sandeep Shetty., _(*6)

Spec

Implementation MUST have a method/function called validate which takes a single string argument., _(*7)

The validate method/function MUST return a boolean value., _(*8)

Before a string is validates it MUST be normalized. Normalization of the string MUST:, _(*9)

• remove any suffixed digits,
• change case to lowercase,
• remove a single s character if the string ends with an s.

addToList

Implementation CAN contain addToList (or add_to_list if more appropriate for the language) method/function that will add other items to the blacklist., _(*10)

addToList method/function MUST accept single string argument., _(*11)

addToList method/function CAN accept an array of strings as a single argument., _(*12)

Before a string item is added to the blacklist via addToList method/function the default blacklist MUST be loaded., _(*13)

Before a string item is added to the blacklist it MUST be normalized with the rules above., _(*14)

getList

Implementation CAN contain getList (or get_list if more appropriate for the language) method/function that will return the blacklist., _(*15)

Using and Languages

For more information about how to use this list in your specific language, please refer to README.md file in the language's folder., _(*16)

Currently supported:, _(*17)

• php - more info - $ composer require michaldudek/subdomain-blacklist dev-master

Planned:, _(*18)

• JavaScript (node.js)
• JavaScript (browser)
• Go
• Ruby
• Python

You are welcome to add support for other languages., _(*19)

Contributing

At this moment pull requests with support for various languages are most welcome., _(*20)

If you add a language support make sure to cover it with appropriate tests., _(*21)

Also if you think some words should be added to the list either open an issue or do a PR., _(*22)

If you are editing a code please make sure to adhere to common patterns and rules in that language., _(*23)

See more in each languages specific README.md file in their appropriate directory., _(*24)