Skip to main content

An utility to protect user privacy

Project description

Fawkes

Fawkes is a privacy protection system developed by researchers at SANDLab, University of Chicago. For more information about the project, please refer to our project webpage. Contact as at fawkes-team@googlegroups.com.

We published an academic paper to summary our work "Fawkes: Protecting Personal Privacy against Unauthorized Deep Learning Models" at USENIX Security 2020.

If you would like to use Fawkes to protect your images, please check out our binary implementation on the website.

Copyright

This code is intended only for personal privacy protection or academic research.

We are currently exploring the filing of a provisional patent on the Fawkes algorithm.

Usage

$ fawkes

Options:

  • -m, --mode : the tradeoff between privacy and perturbation size
  • -d, --directory : the directory with images to run protection
  • -g, --gpu : the GPU id when using GPU for optimization
  • --batch-size : number of images to run optimization together
  • --format : format of the output image.

when --mode is custom:

  • --th : perturbation threshold
  • --max-step : number of optimization steps to run
  • --lr : learning rate for the optimization
  • --feature-extractor : name of the feature extractor to use
  • --separate_target : whether select separate targets for each faces in the diectory.

Example

fawkes -d ./imgs --mode mid

Tips

  • Select the best mode for your need. Low protection is effective against most model trained by individual trackers with commodity face recongition model. mid is robust against most commercial models, such as Facebook tagging system. high is robust against powerful modeled trained using different face recongition API.
  • The perturbation generation takes ~60 seconds per image on a CPU machine, and it would be much faster on a GPU machine. Use batch-size=1 on CPU and batch-size>1 on GPUs.
  • Turn on separate target if the images in the directory belong to different person, otherwise, turn it off.
  • Run on GPU. The current fawkes package and binary does not support GPU. To use GPU, you need to clone this, install the required packages in setup.py, and replace tensorflow with tensorflow-gpu. Then you can run fawkes by python3 fawkes/protection.py [args].

How do I know my images are secure?

We offer two ways to test the robustness of our detection and both of which requires certain level of coding experience. More details please checkout in evaluation directory.

Quick Installation

Install from [PyPI][pypi_fawkes]:

pip install fawkes

If you don't have root privilege, please try to install on user namespace: pip install --user fawkes.

Citation

@inproceedings{shan2020fawkes,
  title={Fawkes: Protecting Personal Privacy against Unauthorized Deep Learning Models},
  author={Shan, Shawn and Wenger, Emily and Zhang, Jiayun and Li, Huiying and Zheng, Haitao and Zhao, Ben Y},
  booktitle="Proc. of USENIX Security",
  year={2020}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fawkes-0.0.8.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

fawkes-0.0.8-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file fawkes-0.0.8.tar.gz.

File metadata

  • Download URL: fawkes-0.0.8.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.2

File hashes

Hashes for fawkes-0.0.8.tar.gz
Algorithm Hash digest
SHA256 668d013e93685efaea5e33869d18e14b53df4d22865261e88d8457040ba9371d
MD5 4e47d052c368369dd031850ee49b8df2
BLAKE2b-256 fbab3d037b729c93a6bc75dadbe2baa4385e9537321c959575159b2d919095a3

See more details on using hashes here.

File details

Details for the file fawkes-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: fawkes-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.2

File hashes

Hashes for fawkes-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a73c40035e381982a21d9eb9779f15ff8155d1c086c783c560147e05874bf0e0
MD5 9dcb6919a8829d09bd8c80272733cbd0
BLAKE2b-256 6b518daa88671cadba1a50e519937ff50c4480c45d6b3ab73d5ac6976de84fca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page