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

Rename this library? (and if so, alternative names wanted!) #76

Open
G-Rath opened this issue Mar 20, 2022 · 4 comments
Open

Rename this library? (and if so, alternative names wanted!) #76

G-Rath opened this issue Mar 20, 2022 · 4 comments
Labels
help wanted Extra attention is needed question Further information is requested

Comments

@G-Rath
Copy link
Owner

G-Rath commented Mar 20, 2022

Originally I called this osv-detector because I felt "auditor" and "scanner" were a bit overloaded, and I was considering if this was to be published as a package somewhere, osv-detector would be less likely to have already been taken.

However, I'm now thinking if it would be better to call it something else for a few reasons:

  1. I'm thinking about additional checks we could be doing, like Support checking if things are approaching EOL with endoflife.date  #75 (I don't think this is probably worth it)
  2. Go packages/binaries are not restricted to unique names, and osv-detector might not be as easy to find as say "security-auditor"
  3. osv-detector is sort of wrong, as this tool isn't for "detecting OSVs"...

But the real blocker for me is what to actually call it instead - I'd prefer to not use "lockfile" (e.g lockfile-auditor) because that'd put us back in the same place if we start auditing more than them (but then maybe it's fine?)

@G-Rath G-Rath pinned this issue Mar 20, 2022
@dp4rk
Copy link

dp4rk commented Apr 8, 2022

What about renaming it to be an action instead of a noun?
`check-for-osvs' or something similar where "check" is the actionable word instead of the current "detect". It might give you more flexibility that way.

@G-Rath
Copy link
Owner Author

G-Rath commented Apr 8, 2022

I'm not against that, but I think it's the "osv" part that I'm interested in replacing more than anything because that's the part that only makes sense if you know what osv stands for.

@G-Rath G-Rath added help wanted Extra attention is needed question Further information is requested labels Apr 10, 2022
@zinderic
Copy link

zinderic commented Feb 1, 2023

What is the relationship with https://github.com/google/osv-scanner ? It has the "osv-scanner" name and I see both projects share code so deciding on the name should probably take that into account.

I find "osv" a bit unfriendly to folks not knowing what it stands for, I know I had to look it up. Maybe something around the more commonly used "oss" since all those dependencies it works with are mostly opensource dependencies that are public and therefore have vulnerability info in public databases?

@G-Rath
Copy link
Owner Author

G-Rath commented Feb 1, 2023

The scanner is a project belonging to Google who also maintain the osv.dev API which backs both the scanner and the detector (for it's API database).

We're got very similar goals which lead to me "donating" the lockfile and semantic packages to the scanner as they were the next step for Google which I happened to build while they were working on the backend - since then, I'm now something of a core contributor to the scanner too.

The detector is still very much being maintained (especially as we're using it internally at Ackama), though one day the scanner might have enough parity with the detector to properly replace it in full.

I agree that "osv" is a bit of an obscure term, though I thought it was better than futher overloading terms like "audit-app", "security scanner", etc (which also tend to be published packages already).

oss-detector is an interesting idea 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants