Skip to content

SoheilKhodayari/same-site-wiki

Repository files navigation

SameSiteWiki

SameSite Cookies Wiki

Website | Wiki | Quick Start | Paper

🍪 SameSite Wiki

Open Source Love Tweet

A simple wiki with all you need to know about SameSite cookies (but were afraid to ask?). Specific focus on principal concepts, security risks, and correct and secure SameSite configurations.

An online version of the Wiki is available at https://soheilkhodayari.github.io/same-site-wiki/docs/main.html.

This project is available as open source under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE V3.0. See LICENSE for more information.

🚀 Quick Start

This repository uses the Jekyll just-the-docs as a GitHub pages remote theme, with the configuration specified in _config.yaml:

remote_theme: just-the-docs/just-the-docs
color_scheme: "dark"

💻 Automatic Deployment

The repository uses Github Actions to automatically build and publish a static version of the SameSite Wiki with Jekyll once a commit is merged with the master branch (i.e., a Pull Request is accepted).

🏭 Local Build

Docker: You can build and run this Wiki inside a Docker container with:

$ docker-compose build
$ docker-compose up

Host Machine: alternatively, you can build it inside your host machine with:

$ gem install just-the-docs
$ bundle exec jekyll serve

For more information, please refer to the official just-the-docs and Jekyll documentations.

🙋 Questions

For any questions, suggestions, feedback or concerns, please raise an issue in the repository. We would be delighted to know if there is any specific behaviour you would like to see documented, but is currently missing from the Wiki. For private issues, you can reach out to me via email.

🎃 Contribution and Code Of Conduct

Bug reports and pull requests are always more than welcomed on GitHub. For more information, please refer to contribution guidelines.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the contributor code of conduct.

📝 Academic Publication

The contents of this repository has been published as a part of a S&P'22 paper. If you use the SameSite Wiki for academic research, we encourage you to cite the following paper:

@inproceedings {SKhodayariSP22SameSite,
  author = {Soheil Khodayari and Giancarlo Pellegrino},
  title = {The State of the SameSite: Studying the Usage, Effectiveness and Adequacy of SameSite Cookies},
  booktitle = {Proceedings of the 43rd IEEE Symposium on Security and Privacy},
  year = {2022},
}