Skip to content

Latest commit

 

History

History
378 lines (315 loc) · 12.4 KB

CONTRIBUTING.md

File metadata and controls

378 lines (315 loc) · 12.4 KB
Raw

Contributing to 2fa.directory

All the data is managed through a series of JSON files so it may be useful to read up on the JSON syntax.

To add a new site, go to the data files and get familiar with how it is set up. There is one file per entry named after the domain, located in the subdirectory starting with the first letter of the domain. Site icons are stored in folders corresponding to each of those entries in their own folder.

Guidelines

  1. Don't break the build: We have a simple continuous integration system setup with GitHub Actions. If your pull request doesn't pass, it won't be merged. GH Actions will only check your changes after you submit a pull request. If you want to test locally, instructions are listed below. Keep reading!
  2. Use a Nice Icon: SVG is the preferred format. If possible, please also run the image through an optimizing utility such as svgo to reduce the file size. If an SVG icon is not available, the icon should be a PNG with a resolution of 32x32, 64x64 or 128x128. If possible, please also run the image through an optimizing utility such as TinyPNG before committing it to the repo and keep the file to be under 2.5 kB.
  3. HTTPS links: All sites that support HTTPS should also be linked with an HTTPS address.
  4. Similarweb top 200K: A new site that is not already listed has to be within the Similarweb top 200,000 ranking. You can check the ranking of a site here.
  5. No 2FA providers: We do not list 2FA providers, such as Authy, Duo or Google Authenticator.
  6. Be Awesome: You need to be awesome. That is all.

Running Locally

There are detailed instructions on installing dependencies and running locally available in the README.

Testing with Bundler

There are a number of tests that are run automatically for a GitHub pull request. They are listed in .github/workflows/repository.yml in the tests: block. You can run these manually as well, e.g to test your JSON changes:

$ bundle exec ruby ./tests/validate-json.rb

Site Criteria

The following section contains rough criteria and explanations regarding what websites should be listed on 2fa.directory. If one of the following criteria is met, it belongs on 2fa.directory:

  1. Personal Info/Image: Any site that deals with personal info or a person's image. An example of a site with Personal Info would be their Amazon account and a site regarding Personal Image would be one like Twitter.
  2. Data: This criteria relates to data that is either important or sensitive. Websites detailed in criteria 1 also fit this criteria.
  3. Money: Any site that deals with money.
  4. Control: This criteria is more general, in that it includes sites that give access to things that may infringe upon criteria 1, 2, or 3. An example of this is a website that allows remote access to a device.

If you have any questions regarding whether or not a site matches one of the criteria, simply open an issue and we'll take a look.

Excluded Sites

A list for excluded sites and categories has also been created with various categories and sites that we have opted not to list on 2fa.directory. You should check the list in the EXCLUSION.md file to make sure that your site is eligible before submitting a pull request.

New Sites

First and foremost, make sure the new site meets our definition requirements of two factor authentication.

If you are adding multiple sites to the TwoFactorAuth list, please create a new git branch for each website, and submit a separate pull request for each branch. More information regarding how to create new git branches can be found on GitHub's Help Page or DigitalOcean's Tutorial.

Adding a new website should be pretty straight-forward. Create a JSON file in the corresponding subdirectory as shown in the following example:

{
  "Site Name": {
    "domain": "site.com",
    "img": "site.com.png",
    "tfa": [
      "sms",
      "call",
      "email",
      "totp",
      "u2f",
      "custom-software",
      "custom-hardware"
    ],
    "documentation": "<link to site TFA documentation>",
    "keywords": [
      "keyword1",
      "keyword2"
    ]
  }
}
  • The domain should point to the main page of the service, not the login page (usually the root domain, not a subdomain).
  • Keywords must be selected from the values listed in categories.json.
  • The default value for the icon is <domain>.svg, but can be overridden by an img field.
  • If you would like the site's link on 2fa.directory to be different to https://<domain>, you can use a url field to specify this.

Adding a site that supports TFA

Sites that provide TFA can be noted with the tfa field and should contain the TFA methods supported. If a site does provide TFA, it is strongly recommended that you add the documentation field where public documentation is available. Sites supporting TFA must not have a contact property.

The following is an example of a website that supports TFA:

{
  "YouTube": {
    "domain": "youtube.com",
    "tfa": [
      "sms",
      "call",
      "totp",
      "custom-software",
      "u2f"
    ],
    "documentation": "https://www.google.com/intl/en-US/landing/2step/features.html",
    "keywords": [
      "entertainment"
    ]
  }
}

Adding a site that does not support TFA

If a site does not provide TFA, the contact field should be included. Inside of this object,

  • The twitter field should be included if the site uses Twitter.
  • Facebook can also be included using the facebook field.
  • Email can be included using the email field.
  • The language field inside contact can be included for websites whose social media pages/communication channels do not use English. The language codes should be lowercase ISO 639-1 codes.

The fields tfa and documentation are not necessary.

The following is an example of a website that does not support TFA:

{
  "Netflix": {
    "domain": "netflix.com",
    "url": "https://www.netflix.com/us/",
    "contact": {
      "facebook": "netflix",
      "twitter": "Netflixhelps"
    },
    "keywords": [
      "entertainment"
    ]
  }
}

Exceptions & Restrictions

If a site requires the user to do something out of the ordinary to set up 2FA or if 2FA is only available in specific countries or to specific account types, you can document this using the notes field.

{
  "Site Name": {
    "domain": "site.com",
    "tfa": [
      "totp"
    ],
    "documentation": "<link to site TFA documentation>",
    "notes": "Specific text goes here.",
    "keywords": [
      "keyword"
    ]
  }
}

Adding a site that is only available or is prevalent in specific regions

If a site (with or without 2FA) is only available in certain countries or most users are located in certain countries - for example a government site - you can note this with the regions field.

{
  "Site Name": {
    "domain": "site.com",
    "tfa": [
      "totp"
    ],
    "documentation": "<link to site TFA documentation>",
    "keywords": [
      "keyword"
    ],
    "regions": [
      "us",
      "ca"
    ]
  }
}

The country codes should be lowercase ISO 3166-1 codes.

Excluded Regions

If a site is available globally apart from a specific region, this can be noted using the regions array. Excluded regions should be prefixed with a - symbol to exclude the site from that region. Region codes and excluded region codes should not be used together, as adding a region code automatically excludes the site from other regions. The example below shows a site that is available in all regions apart from us.

{
  "Site Name": {
    "domain": "site.com",
    "tfa": [
      "totp"
    ],
    "documentation": "<link to site TFA documentation>",
    "keywords": [
      "keyword"
    ],
    "regions": [
      "-us"
    ]
  }
}

Other Properties

  • additional-domains If a site exists at another domain in addition to the main domain that is listed in the domain field, you can mark this with the additional-domains property.
{
  "Site Name": {
    "domain": "site.com",
    "additional-domains": [
      "site.net",
      "site.io"
    ],
    "tfa": [
      "totp"
    ],
    "documentation": "<link to site TFA documentation>",
    "keywords": [
      "keyword"
    ]
  }
}
  • recovery The recovery field can be used to link to acccount recovery documentation about what to do if you lose access to your 2FA method.
{
  "Site Name": {
    "domain": "site.com",
    "tfa": [
      "totp"
    ],
    "documentation": "<link to site TFA documentation>",
    "recovery": "<link to site TFA recovery documentation>",
    "keywords": [
      "keyword"
    ]
  }
}
  • custom-software/custom-hardware If a site uses a proprietary software or hardware method, you can add specific details of what is being used. Examples would be Authy or non-U2F security keys.
{
  "Site Name": {
    "domain": "site.com",
    "tfa": [
      "custom-software",
      "custom-hardware"
    ],
    "custom-software": [
      "Authy"
    ],
    "custom-hardware": [
      "Yubico OTP"
    ],
    "documentation": "<link to site TFA documentation>",
    "keywords": [
      "keyword"
    ]
  }
}

New Categories

To add a new category, modify the categories file and follow the template below:

  {
    "name" : "category-id",
    "title": "Category Title",
    "icon": "icon-class"
  },

The icon-class value needs to be chosen from Font Awesome.

Then you can use the category-id as a keyword in the JSON file of your entry.

Pro Tips

  • See Guideline #2 about icons. The SVG file should go in the corresponding img/ folder.

  • For the sake of organization and readability, it is appreciated if your site chunk follows the same order as the example earlier in the document.

  • If a site supports TFA, their contact information is not needed and must be left out.

A Note on Definitions

Authorization

There are lots of different ideas of what constitutes two factor authentication and what doesn't, so it stands to reason that we should clarify a bit. For the purposes of this site, two factor authentication is defined as any service provided as a redundant layer for account authentication. Services that provide authorization redundancy are certainly appreciated, but should not be considered two factor authentication.

As an example, a site that prompts you for an authentication token following user login would be considered two factor authentication. A site that does not prompt you for a token upon login, but prompts you for a token when you try to perform a sensitive action would not be considered two factor authentication.

For context, check out the discussion in issue #242.

Passwordless Authentication

Many sites are now offering passwordless authentication, which replace the password (something you know) with a different factor, such as something you have or are. Examples of this would be sites which allow users to use a U2F key, or a magic link to login, but do not have a second factor available. Since there is still only one factor being used (although it may not be a password), it does not constitute two factor authentication.