Translations

The vulnerability database format supports translations. Each currently supported language is in the db directory.

Before translating the database

Translating open source projects is great. Not everyone speaks English, translating the vulnerability database will make us reach more people around the world. Thanks ❤️ .

Most likely you want to translate the database to your language because you use a tool, such as w3af, which gets it's vulnerability information from https://github.com/vulndb/data/. If you want to be sure that you'll be able to use the vulndb translation in your favorite project, you should check the documentation or talk with the project leader. Not all projects that use vulndb support translations.

How to create a new translation

Let's say that you want to translate the vulnerability database to Japanese. These are the main steps to follow to create the translation and get it accepted:

1. Create a directory with the language code in the db directory. For Japanese the code is ja, so the directory structure will end up being db/ja.
2. Copy all the contents of the en directory to the db/ja directory
3. Translate five JSON files in db/ja and 3 markdown files in db/ja/descriptions
4. Send a pull request to vulndb/data
5. Have someone else that speaks your language review the translation via the pull request system
6. At this point we will either accept or reject your partial translation. If it was accepted you will get a lot of feedback and will be able to complete the translation more easily
7. Translate all the files in db/ja
8. Commit and push the new changes to your fork, they should appear in the pull request
9. We merge your PR

Do not translate

Do not translate the file names.

Also, when translating json file contents, please do not translate the keys. For example, in 1-allowed-http-methods.json:

{
  "id": 1, 
  "title": "Allowed HTTP methods", 
  "severity": "informational", 

Keys such as id, title and severity must NOT be translated.

Also, please do NOT translate the following sections:

  "severity": "informational",
  "description": {
    "$ref": "#/files/description/1"
  }, 
  "fix": {
    "effort": 50, 
    "guidance": {
      "$ref": "#/files/fix/39"
    }
  }, 

• The value of the severity field
• Any value of $ref