Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use shorter VULCOID #695

Closed
pombredanne opened this issue Apr 12, 2022 · 8 comments · Fixed by #700
Closed

Use shorter VULCOID #695

pombredanne opened this issue Apr 12, 2022 · 8 comments · Fixed by #700

Comments

@pombredanne
Copy link
Member

VULCOID-83718eba-2c1b-4bdf-8704-7581b1f02dbc is too long.
IMHO we should instead adopt something shorter.
For instance, GitHub uses GHSA-jfh8-c2jp-5v3q eg. likely four characters on a base64-like encoding.
We could adopt a similar scheme. Or we could adopt something that more memorable.

@Hritik14
Copy link
Collaborator

How about VULCOID-YEAR-ABCD where ABCD is any alphanumeric (case insensitive). It comes out to 36^4 = 1679616 per year which is huge and I wonder if we'll ever have that many vulnerabilities per year. Even if we do, we'll add one more character.

@TG1999
Copy link
Contributor

TG1999 commented Apr 19, 2022

VULCOID are now looking something like this VULCOID-4PH. They are not so random and they are also memorable, here I am converting any id from base 10 to base 36, we can also decode them easily by going from base 36 to base 10, so what's your thought on this

@Hritik14
Copy link
Collaborator

@TG1999 That gives us 46656 vulnerabilities for life. We could add another character but then it will be ever-growing. I still feel we should go the route of year prefix as people at CVE did. Also, as the year will come from the data source, it might help a little while we're gathering vulcoids from multiple vulnerablecode installations.

@TG1999
Copy link
Contributor

TG1999 commented Apr 19, 2022

@TG1999 That gives us 46656 vulnerabilities for life.

I doubt that, 36^4 = 1679616 and if we go on adding 5th character that's 60 Million vulnerabilities

@pombredanne
Copy link
Member Author

pombredanne commented Apr 19, 2022

Do we want a namespace that would identify a VulnerableCode installation from all other installations?
The idea would be to ensure that different installation generate different vulnerability ids.
Or we would say that VULCOID is the namespace and is only usable with VulnerableCode own installation?

@pombredanne
Copy link
Member Author

pombredanne commented Apr 19, 2022

Here is a suggestion for a vote:
We will compute and store a VULCOID-XXXX where XXXX is variable length and is the uppercase base36-encoding of the id/pk of the Vulnerability model. XXXX is case-insensitive.
We can change this in the future

@Hritik14
Copy link
Collaborator

Further suggestions

VULCOID-YEAR-ABCD

  • Year is hard to infer for all vulnerabilities.

VULCOID-ABC

  • Variable length base 36 ABC

VULCOID-[NAMESPACE-]ABC

  • Same as VULCOID-ABC but with a reserved space for NAMESPACE that could be an identifier AboutCode supplies via Scancode Toolkit or any other means. (Unique values such as github usernames could also be leveraged)

@pombredanne
Copy link
Member Author

With 4 votes, here is the pick for now.

Here is a suggestion for a vote:
We will compute and store a VULCOID-XXXX where XXXX is variable length and is the uppercase base36-encoding of the id/pk of the Vulnerability model. XXXX is case-insensitive.

TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 22, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 22, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 22, 2022
@TG1999 TG1999 linked a pull request Apr 22, 2022 that will close this issue
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 26, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 26, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 26, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 26, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue Apr 28, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue May 3, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue May 3, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue May 3, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue May 4, 2022
TG1999 added a commit to TG1999/vulnerablecode that referenced this issue May 4, 2022
@Hritik14 Hritik14 mentioned this issue Jul 26, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants