Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/covenantsql/cookiescanner
Cookie Scanner for GDPR compliance
https://github.com/covenantsql/cookiescanner
cookie covenantsql cql gdpr privacy
Last synced: 15 days ago
JSON representation
Cookie Scanner for GDPR compliance
- Host: GitHub
- URL: https://github.com/covenantsql/cookiescanner
- Owner: CovenantSQL
- License: apache-2.0
- Created: 2019-03-27T10:52:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-31T08:38:17.000Z (over 1 year ago)
- Last Synced: 2025-01-17T07:05:07.247Z (22 days ago)
- Topics: cookie, covenantsql, cql, gdpr, privacy
- Language: Go
- Homepage: https://gdprexpert.io/
- Size: 16.8 MB
- Stars: 187
- Watchers: 11
- Forks: 46
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookie Scanner
GDPR requires that all websites that provide services to European users must provide a complete report on the use of cookies to record user information and continue to use it with the express consent of the user.
There are several commercial Cookie Scanner online.
But we decide to make our implementation Open Source. Hope to help more people getting aware of the privacy problems.
Cookie Scanner is a simple utility to analyze website cookie status and generate reports for GDPR-compliance.
For how to use the "Cookie Database", please see [CQL QuickStart](https://developers.covenantsql.io/docs/en/quickstart)
Frontpage sets Cookie without user Consent:
- Amazon.com: [9 Cookies](./example/amazon-cookie.pdf)
- Reddit.com: [9 Cookies](./example/reddit-cookie.pdf)
- Netflix.com: [6 Cookies](./example/netflix-cookie.pdf)
- Ebay.com: [5 Cookies](./example/ebay-cookie.pdf)
- Google.com: [2 Cookies](./example/google-cookie.pdf)
- Facebook.com: 0 Cookie
### Features
1. Nice HTML or PDF report
1. Detailed cookie description
1. We collected more than 10000 cookie description and put them in free DB service CQL:
- DSN: covenantsql://050cdf3b860c699524bf6f6dce28c4f3e8282ac58b0e410eb340195c379adc3a
- [Config & Key](./config)
### Online Demo
Your can just try Cookie Scanner on [gdprExpert.io](https://gdprexpert.io/)
### Installation
Requires MacOS/Linux system.
First, install [`Google Chrome`](https://www.google.com/chrome/) in your operating system.
Or you can start a headless Chrome in docker with
```shell
$ docker container run -d -p 9222:9222 zenika/alpine-chrome --no-sandbox \
--remote-debugging-address=0.0.0.0 --remote-debugging-port=9222
```
Then, install the `CookieScanner` using `go get`.
```shell
$ go get github.com/CovenantSQL/CookieScanner
```
### Usage
CookieScanner is capable of geneating reports in `json/html/pdf` format.
```
$ CookieScanner --help
usage: CookieScanner [] [ ...]
website cookie usage report generator
Flags:
--help Show context-sensitive help (also try --help-long
and --help-man).
--chrome=CHROME chrome application to run as remote debugger
--verbose run debugger in verbose mode
--timeout=1m0s timeout for a single cookie scan
--wait=WAIT wait duration after page load in scan
--classifier=CLASSIFIER classifier database for cookie report
--log-level=LOG-LEVEL set log level
Commands:
help [...]
Show help.
cli []
generate report for a single website
version
get debugger version
server []
start a report generation server
$ CookieScanner cli --help
usage: CookieScanner cli []
generate report for a single website
Flags:
--help Show context-sensitive help (also try --help-long
and --help-man).
--chrome=CHROME chrome application to run as remote debugger
--verbose run debugger in verbose mode
--timeout=1m0s timeout for a single cookie scan
--wait=WAIT wait duration after page load in scan
--classifier=CLASSIFIER classifier database for cookie report
--log-level=LOG-LEVEL set log level
--headless run chrome in headless mode
--port=9222 chrome remote debugger listen port
--json print report as json
--html=HTML save report as html
--pdf=PDF save report as pdf
Args:
site url
```
### Examples
Generate HTML report for `covenantsql.io` using cli mode.
```shell
$ CookieScanner cli \
--headless \
--classifier "covenantsql://050cdf3b860c699524bf6f6dce28c4f3e8282ac58b0e410eb340195c379adc3a?config=./config/config.yaml" \
--html cql.html covenantsql.io
```
Just wait for a while, you will found `cql.html` showing results like this:
