├── index.js ├── README.md ├── test └── basic.js ├── package.json ├── LICENSE └── .gitignore /index.js: -------------------------------------------------------------------------------- 1 | 2 | module.exports = function () { 3 | return function (req, res, next) { 4 | req.globalPrivacyControl = !!(req.headers['sec-gpc'] && req.headers['sec-gpc'].charAt(0) === '1'); 5 | next(); 6 | }; 7 | }; 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # express-gpc 2 | 3 | A basic Express middleware to support easy detection of the GPC flag 4 | (https://globalprivacycontrol.org/). 5 | 6 | ``` 7 | let express = require('express') 8 | , detectGPC = require('express-gpc') 9 | , app = express() 10 | ; 11 | 12 | app.use(detectGPC()); 13 | 14 | app.get('/', (req, res) => { 15 | if (req.globalPrivacyControl) { 16 | // don't sell this person's data 17 | } 18 | else { 19 | // ah, no privacy for you! 20 | } 21 | }) 22 | ``` 23 | -------------------------------------------------------------------------------- /test/basic.js: -------------------------------------------------------------------------------- 1 | 2 | let detectGPC = require('..') 3 | , { equal } = require('assert') 4 | ; 5 | 6 | describe('Detect GPC', function () { 7 | it('handles detection', () => { 8 | [ 9 | { header: undefined, value: false }, 10 | { header: '0', value: false }, 11 | { header: 'cat', value: false }, 12 | { header: '1', value: true }, 13 | { header: '1;with extension', value: true }, 14 | ].forEach(({ header, value }) => { 15 | let req = { headers: { 'sec-gpc': header }}; 16 | detectGPC()(req, {}, () => {}); 17 | equal(value, req.globalPrivacyControl, `Correct value for "${header}"`); 18 | }); 19 | }); 20 | }); 21 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "express-gpc", 3 | "version": "1.0.0", 4 | "description": "Easy detection of the GPC flag (https://globalprivacycontrol.org/)", 5 | "main": "./index.js", 6 | "scripts": { 7 | "test": "mocha --reporter spec --bail" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/darobin/express-gpc.git" 12 | }, 13 | "author": "Robin Berjon ", 14 | "license": "MIT", 15 | "bugs": { 16 | "url": "https://github.com/darobin/express-gpc/issues" 17 | }, 18 | "homepage": "https://github.com/darobin/express-gpc", 19 | "devDependencies": { 20 | "mocha": "^8.2.1" 21 | }, 22 | "dependencies": {} 23 | } 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Robin Berjon 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | --------------------------------------------------------------------------------