benbalter / gman Goto Github PK

A ruby gem to check if the owner of a given email address or website is working for THE MAN (a.k.a verifies government domains).

Home Page: http://ben.balter.com/gman/

License: MIT License

Ruby 96.03% Shell 3.97%

government email

gman's Introduction

Gman

A ruby gem to check if the owner of a given email address or website is working for THE MAN (a.k.a verifies government domains). It will also provide you with metadata about the domain, such as the country, state, city, or agency, where applicable. It does this by leveraging the power of Naughty or Nice, the Public Suffix List, and the associated Ruby Gem.

You could theoretically use regex, but either you'll get a bunch of false positives, or your regex will be insanely complicated. gov.uk, may be valid, for example, but gov.fr is not (it's gouv.fr, for what it's worth). The solution? Use Public Suffix to verify that it's a valid public domain, then maintain a crowd-sourced sub-list of known global government and military domains. It should cover all US and international, government and military domains for both email and website verification.

See a domains that's missing or one that shouldn't be there? We'd love you to contribute.

Installation

Gman is a Ruby gem, so you'll need a little Ruby-fu to get it working. Simply

gem install gman

Or add this to your Gemfile before doing a bundle install:

gem 'gman'

Usage

In general

Verify email addresses

Gman.valid? "[email protected]" #=> true
Gman.valid? "[email protected]" #=> false

Verify domain

Gman.valid? "http://foo.bar.gov" #=> true
Gman.valid? "foo.bar.gov"        #=> true
Gman.valid? "foo.gov"            #=> true
Gman.valid? "foo.biz"            #=> false

Determine the type of domain

domain = Gman.new "whitehouse.gov"
domain.type     #=> :federal
domain.federal? #=> true
domain.state?   #=> false
domain.city?    #=> false
domain.county?  #=> false

Get information about the domain's geographic location (.gov and .us only)

domain = Gman.new "illinois.gov"
domain.state #=> "IL"
domain.city  #=> "springfield"

Get information about a .gov domain's owner

domain = Gman.new "whitehouse.gov"
domain.agency   #=> "Executive Office of the President"

Get the ISO Country Code information represented by a government domain

domain = Gman.new "whitehouse.gov" #=> #<Gman domain="whitehouse.gov" valid=true>
domain.country.name                #=> "United States"
domain.country.alpha2              #=> "US"
domain.country.alpha3              #=> "USA"
domain.country.currency            #=> "USD"
domain.country.calling_code        #=> "+1"

Check if a country is on the US Sanctions list

Gman.new("foo.gov.kp").sanctioned? #=> true

Command line

Getting information about a given domain

$ gman whitehouse.gov
Domain  : whitehouse.gov
Valid government domain
Type    : federal
Country : United States
State   : DC
City    : Washington
Agency  : Executive Office of the President

The command line tool will accept any domain-like string (email, url, etc.)

$ gman [email protected]
Domain  : illinois.gov
Valid government domain
Type    : state
Country : United States
State   : IL
City    : Springfield

Filter

Filters newline-separated email addresses from stdin. Example usage:

$ gman_filter < path/to/list/of/addresses.txt

Contributing

Contributions welcome! Please see the contribution guidelines for code contributions or for details on how to add, update, or delete government domains.

Credits

Heavily inspired by swot. Thanks @leereilly!

gman's People

Contributors

Stargazers

Watchers

Forkers

leereilly kcmojohn smathermather-cm zvruwink jasonlally vykster stephenott mrcoulson mcgrathjoe gsa afeijoo jlord piercecountywa eriksarnold pikesley pborreli adamamyl nangal mitio ceedrive pombredanne elizabethn akuckartz fredj step21 palcu atvirasvilnius acedubs bkeepers riseofthetigers vdedyukhin plrolle proxymoron digideskio jbjonesjr ccantey mrphishxxx sitle jjediny loveforlilypads thomaslamb enterstudio seiteta pieterjanpauwels bvelastegui linzhineng linuxwebexpert rasky brntbeer alegomes tscung schnuerle ovflowd ianlee1521 ezr-ondrej firefoxxy8 dobrowski lowellweisbord kinverarity1 elstudio 0xflotus reviforks gaybro8777 jchassery1 nschonni bomberstudios realeroberto webmarketingmana dyet92k jdukpa ggentili mzagaja tryweirder flacunza optionalg alranel matikin9 cyberflamego loganibo iq-scm paaschdxt

gman's Issues

Gov employee email requirements

So some considerations for government email proof requirements.

Private contractors are often given government emails on a temp basis for contract work.
What falls outside of the government employee definition?
- Teachers with a public school board
- Firefighter, police officer
- nurse that works at a veterans hospital or nurse that works for the municipal public health clinic
- An organization such as a Canadian crown corporation such as viarail.ca. It is listed as a government department/agency: http://gc.ca/depts/major/depind-eng.html, but I bet you would have a hard time finding someone who would say that a Via-Rail employee would be considered a "government employee". But another example of a crown corporation would be the Canadian Postal Service (canadapost.ca

Thoughts?

Update to public suffix 2.x

lib/domains.txt non-existant

File is referred to in the CONTRIBUTING section

Identify type of government domain

Would be awesome if, given a domain, GMAn were able to return the type of government entity it belongs to.

At the very least, perhaps the rule group from domains.txt, but ideally, the country / state / city locality, even in a human-readable format.

please add amsterdam.nl

Employees at State Universites

I noticed that Gman doesn't validate .edu email addresses for state universities. Is this because of the potential for students to sign up?

A number of universities, mine included, have different domains for employee versus student emails. For example, at George Mason University employee emails are @gmu.edu and student emails are @masonlive.gmu.edu. I haven't dug into the gem to see if this type of stratification is possible but before I go about submitting a PR I wanted make sure there wasn't another reason that .edu was being excluded so I don't do some unwanted work. :)

Update GMan

Hello GMan!

Nice-to-have: Associate with the name/OMB code for the agency

Domain Takedown Request

I am part of the IT Security Team for Forest County Potawatomi Tribe operating as Potawatomi Bingo Casino. You have 1 of our domains listed through your repositories. Please remove all instances of the following: fcpotwatomi.com.

Please let me know if you need more information to expediate this removal. Thank you!

Reimport USA.gov list, checking for www. variants

Via @afeijoo over in #26:

Many do resolve with the www (but not without it). Ex: anderson.govoffice.com is deleted above but it resolves at http://www.anderson.govoffice.com/. You may want to check both variants in determining the resolvable domains.

vendor-federal-de: updated columns, added cities

Hi,

I just updated the german-gov-domains list to use the same columns as the dotgov domains from gsa/data. The full list contains cities now, but a federal domains only subset is available too.

Integrating gman with the Italian index of public administrations (IPA)

In Italy there are more than 20,000 public bodies, and only a few of them have a domain under the .gov.it hierarchy. This is due to a decision by AGID, whereby the .gov.it hierarchy is reserved for central public administrations only.

However, there do exist an official public API which returns the website for each public entity, the so-called IPA (Indice dei domicili digitali delle pubbliche amministrazioni e dei gestori di pubblici servizi).

IPA is mandated by the Italian law and managed by AGID. It can be queried by requesting a free-of-charge Authorization ID.

Thus, my proposal is to integrate gman with IPA so as to dynamically query the API and return an up-to-date response.

Other Countries might implement similar solutions as well.

@eutopian-eu

Ignore this issue

The non-US government tld for south africa is missing from the list.

It is gov.za

Also, their military tld is mil.za

Vendor GSA Domain list

https://github.com/GSA/data/blob/gh-pages/dotgov-domains/2014-12-01-full.csv

To provide information about what type of government a domain is.

Canadian municipal domains

I've got about 1500, whose domain can be extracted: https://github.com/opencivicdata/ocd-division-ids/blob/master/identifiers/country-ca/ca_census_subdivisions-url.csv

It wouldn't be hard to list the common provincial and territorial domains (gouv.qc.ca, gov.on.ca, etc.)

Gov.Uk domains not detected

the gov.uk SLD is not currently listed in the public suffix directory

No domains of German municipalities ?

The list of domains does not seem to contain any domain controlled by a German municipality. I am in particular missing stadt-koeln.de

Support for tertiary (or N-level) domains

E.g., should be able to whitelist champaign.il.us, without allowing all il.us domains (e.g. k12.il.us).

@johndbritton, @leereilly as the resident public suffix experts, any thoughts on how to do this? Right now it's just looking at TLD or TLD + SLD.

/cc @jlord because state/local gov.

Is your feature request related to a problem? Please describe the problem you're trying to solve.

I dont see mail.mil as an approved domain for granting access to github government

Describe the solution you'd like

Id like to add mail.mil and dds.mil to the list of domains here https://github.com/benbalter/gman/blob/master/config/domains.txt

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.