zap-hud icon indicating copy to clipboard operation
zap-hud copied to clipboard

Terminology: site/domain/target

Open psiinon opened this issue 5 years ago • 3 comments

I dont think we've been using the terms site/domain/target very consistently, or at least I havnt :P Be good to have a definition for HUD terms so we know when to use them. In this case maybe:

  • Site - any website (domain) whether in scope or not
  • Target - the collection of urls that will be subject to tools like the spider or the active scanner. Currently we just support the whole site, but hopefully soon will support more focussed targets
  • Domain - dont use?

Thoughts?

psiinon avatar Oct 24 '18 10:10 psiinon

I think this makes sense. Obviously still using domain where we need to when referring to the technical definition, but not in the same context of "target". So a couple examples that would fit in this definition set:

  • "The site juiceshop.com isn't currently in scope so it is not a part of the target for the HUD."
  • "I've added the site juiceshop.com to the scope, so it is now a part of the target, but I've excluded the page juiceshop.com/#/administration so that page is not a parge of the target."
  • "The spider runs against the target - all of the sites and pages in scope."

And we'd be trying to avoid saying things like:

  • "The domain https://juiceshop.com is not a part of target."

While that last statement might be true we're trying not to conflate "domain" and "site" when referring to targets for tools correct?

dscrobonia avatar Oct 24 '18 14:10 dscrobonia

As a support to @dscrobonia's answer, I would mention that "domain" (and extensively "Origin") are specific and related concepts in a web browser:

  • https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
  • https://developer.mozilla.org/en-US/docs/Web/API/Document/domain

Pamplemousse avatar Oct 25 '18 13:10 Pamplemousse

@psiinon any more thoughts about this?

dscrobonia avatar Nov 03 '18 20:11 dscrobonia