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

Clarify wording in docs/Configuration.md wrt collection_fingerprinting #1014

Open
tim-stephenson opened this issue Oct 14, 2022 · 2 comments
Labels
documentation good-first-bug Bugs that are good for a first-time committer to tackle

Comments

@tim-stephenson
Copy link
Contributor

- The first shortcut is the fingerprinting collection, specified by
`collection_fingerprinting`. This was the default prior to v0.11.0. It contains a collection
of APIs of potential fingerprinting interest:
- HTML5 Canvas
- HTML5 WebRTC
- HTML5 Audio
- Plugin access (via `navigator.plugins`)
- MIMEType access (via `navigator.mimeTypes`)
- `window.Storage`, `window.localStorage`, `window.sessionStorage`,
and `window.name` access.
- Navigator properties (e.g. `appCodeName`, `oscpu`, `userAgent`, ...)
- Window properties (via `window.screen`)
- `collection_fingerprinting` is the default if `js_instrument` is `True`.

The statement:

 - `collection_fingerprinting` is the default if `js_instrument` is `True`. 

Is false, as it is no longer the default. I found this a bit confusing while reading over the docs.

@vringar
Copy link
Contributor

vringar commented Oct 16, 2022

I can confirm that collection_fingerprinting is still the default.

js_instrument_settings: List[Union[str, dict]] = field(
default_factory=lambda: ["collection_fingerprinting"]
)

But I get how the docs are confusing in this aspect.

@vringar vringar added documentation good-first-bug Bugs that are good for a first-time committer to tackle labels Oct 16, 2022
@vringar vringar changed the title Confusing statement/contradiction in docs/Configuration.md Clarify wording in docs/Configuration.md wrt collection_fingerprinting Oct 16, 2022
@vringar
Copy link
Contributor

vringar commented Oct 16, 2022

The docs should be updated to state, that the js_instrument_settings, that were the default prior to v0.11.0 have been grouped into a collection called collection_fingerprinting and that this collection is the default configuration, when enabling the js_instrument.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good-first-bug Bugs that are good for a first-time committer to tackle
Projects
None yet
Development

No branches or pull requests

2 participants