├── .prettierrc ├── .editorconfig ├── vitest.config.js ├── init.sql ├── migrations └── 0001_create_tables.sql ├── package.json ├── test └── index.spec.js ├── .gitignore ├── README.md ├── wrangler.toml ├── src └── index.js └── LICENSE /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 140, 3 | "singleQuote": true, 4 | "semi": true, 5 | "useTabs": true 6 | } 7 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_style = tab 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [*.yml] 12 | indent_style = space 13 | -------------------------------------------------------------------------------- /vitest.config.js: -------------------------------------------------------------------------------- 1 | import { defineWorkersConfig } from "@cloudflare/vitest-pool-workers/config"; 2 | 3 | export default defineWorkersConfig({ 4 | test: { 5 | poolOptions: { 6 | workers: { 7 | wrangler: { configPath: "./wrangler.toml" }, 8 | }, 9 | }, 10 | }, 11 | }); 12 | -------------------------------------------------------------------------------- /init.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS event (id text NOT NULL, pubkey text NOT NULL, created_at integer NOT NULL, kind integer NOT NULL, tags jsonb NOT NULL, content text NOT NULL, sig text NOT NULL); 2 | CREATE UNIQUE INDEX IF NOT EXISTS ididx ON event(id); 3 | CREATE INDEX IF NOT EXISTS pubkeyprefix ON event(pubkey); 4 | CREATE INDEX IF NOT EXISTS timeidx ON event(created_at DESC); 5 | CREATE INDEX IF NOT EXISTS kindidx ON event(kind); 6 | CREATE INDEX IF NOT EXISTS kindtimeidx ON event(kind,created_at DESC); 7 | -------------------------------------------------------------------------------- /migrations/0001_create_tables.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS event (id text NOT NULL, pubkey text NOT NULL, created_at integer NOT NULL, kind integer NOT NULL, tags jsonb NOT NULL, content text NOT NULL, sig text NOT NULL); 2 | CREATE UNIQUE INDEX IF NOT EXISTS ididx ON event(id); 3 | CREATE INDEX IF NOT EXISTS pubkeyprefix ON event(pubkey); 4 | CREATE INDEX IF NOT EXISTS timeidx ON event(created_at DESC); 5 | CREATE INDEX IF NOT EXISTS kindidx ON event(kind); 6 | CREATE INDEX IF NOT EXISTS kindtimeidx ON event(kind,created_at DESC); 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cfrelay", 3 | "version": "0.0.0", 4 | "private": true, 5 | "scripts": { 6 | "deploy": "wrangler deploy", 7 | "dev": "wrangler dev", 8 | "start": "wrangler dev", 9 | "test": "vitest", 10 | "predeploy": "wrangler d1 migrations apply DB --remote", 11 | "seedLocalD1": "wrangler d1 migrations apply DB --local" 12 | }, 13 | "devDependencies": { 14 | "@cloudflare/vitest-pool-workers": "^0.1.0", 15 | "vitest": "1.3.0", 16 | "wrangler": "4.21.x" 17 | }, 18 | "dependencies": { 19 | "@noble/curves": "^1.4.0", 20 | "@noble/hashes": "^1.4.0", 21 | "js-base64": "^3.7.7" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /test/index.spec.js: -------------------------------------------------------------------------------- 1 | import { env, createExecutionContext, waitOnExecutionContext, SELF } from "cloudflare:test"; 2 | import { describe, it, expect } from "vitest"; 3 | import worker from "../src"; 4 | 5 | describe("Hello World worker", () => { 6 | it("responds with Hello World! (unit style)", async () => { 7 | const request = new Request("http://example.com"); 8 | // Create an empty context to pass to `worker.fetch()`. 9 | const ctx = createExecutionContext(); 10 | const response = await worker.fetch(request, env, ctx); 11 | // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions 12 | await waitOnExecutionContext(ctx); 13 | expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`); 14 | }); 15 | 16 | it("responds with Hello World! (integration style)", async () => { 17 | const response = await SELF.fetch("http://example.com"); 18 | expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`); 19 | }); 20 | }); 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | 3 | logs 4 | _.log 5 | npm-debug.log_ 6 | yarn-debug.log* 7 | yarn-error.log* 8 | lerna-debug.log* 9 | .pnpm-debug.log* 10 | 11 | # Diagnostic reports (https://nodejs.org/api/report.html) 12 | 13 | report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json 14 | 15 | # Runtime data 16 | 17 | pids 18 | _.pid 19 | _.seed 20 | \*.pid.lock 21 | 22 | # Directory for instrumented libs generated by jscoverage/JSCover 23 | 24 | lib-cov 25 | 26 | # Coverage directory used by tools like istanbul 27 | 28 | coverage 29 | \*.lcov 30 | 31 | # nyc test coverage 32 | 33 | .nyc_output 34 | 35 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 36 | 37 | .grunt 38 | 39 | # Bower dependency directory (https://bower.io/) 40 | 41 | bower_components 42 | 43 | # node-waf configuration 44 | 45 | .lock-wscript 46 | 47 | # Compiled binary addons (https://nodejs.org/api/addons.html) 48 | 49 | build/Release 50 | 51 | # Dependency directories 52 | 53 | node_modules/ 54 | jspm_packages/ 55 | 56 | # Snowpack dependency directory (https://snowpack.dev/) 57 | 58 | web_modules/ 59 | 60 | # TypeScript cache 61 | 62 | \*.tsbuildinfo 63 | 64 | # Optional npm cache directory 65 | 66 | .npm 67 | 68 | # Optional eslint cache 69 | 70 | .eslintcache 71 | 72 | # Optional stylelint cache 73 | 74 | .stylelintcache 75 | 76 | # Microbundle cache 77 | 78 | .rpt2_cache/ 79 | .rts2_cache_cjs/ 80 | .rts2_cache_es/ 81 | .rts2_cache_umd/ 82 | 83 | # Optional REPL history 84 | 85 | .node_repl_history 86 | 87 | # Output of 'npm pack' 88 | 89 | \*.tgz 90 | 91 | # Yarn Integrity file 92 | 93 | .yarn-integrity 94 | 95 | # dotenv environment variable files 96 | 97 | .env 98 | .env.development.local 99 | .env.test.local 100 | .env.production.local 101 | .env.local 102 | 103 | # parcel-bundler cache (https://parceljs.org/) 104 | 105 | .cache 106 | .parcel-cache 107 | 108 | # Next.js build output 109 | 110 | .next 111 | out 112 | 113 | # Nuxt.js build / generate output 114 | 115 | .nuxt 116 | dist 117 | 118 | # Gatsby files 119 | 120 | .cache/ 121 | 122 | # Comment in the public line in if your project uses Gatsby and not Next.js 123 | 124 | # https://nextjs.org/blog/next-9-1#public-directory-support 125 | 126 | # public 127 | 128 | # vuepress build output 129 | 130 | .vuepress/dist 131 | 132 | # vuepress v2.x temp and cache directory 133 | 134 | .temp 135 | .cache 136 | 137 | # Docusaurus cache and generated files 138 | 139 | .docusaurus 140 | 141 | # Serverless directories 142 | 143 | .serverless/ 144 | 145 | # FuseBox cache 146 | 147 | .fusebox/ 148 | 149 | # DynamoDB Local files 150 | 151 | .dynamodb/ 152 | 153 | # TernJS port file 154 | 155 | .tern-port 156 | 157 | # Stores VSCode versions used for testing VSCode extensions 158 | 159 | .vscode-test 160 | 161 | # yarn v2 162 | 163 | .yarn/cache 164 | .yarn/unplugged 165 | .yarn/build-state.yml 166 | .yarn/install-state.gz 167 | .pnp.\* 168 | 169 | # wrangler project 170 | 171 | .dev.vars 172 | .wrangler/ 173 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cfrelay 2 | 3 | A relay run at cloudflare. 4 | 5 | [![Last Version](https://img.shields.io/github/release/haorendashu/cfrelay.svg?maxAge=3600&label=Stable&labelColor=06599d&color=043b69)](https://github.com/haorendashu/cfrelay) 6 | [![License: GNU General Public License v3.0](https://img.shields.io/github/license/haorendashu/cfrelay?labelColor=27303D&color=0877d2)](https://github.com/haorendashu/cfrelay/LICENSE) 7 | [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/haorendashu/cfrelay)](https://github.com/haorendashu/cfrelay/issues) 8 | 9 | ## Features 10 | 11 | - [x] NIP-01 (Basic protocol flow description) 12 | - [x] NIP-02 (Follow List) 13 | - [x] NIP-05 (Mapping Nostr keys to DNS-based internet identifiers) 14 | - [x] NIP-09 (Event Deletion) 15 | - [x] NIP-11 (Relay Information Document) 16 | - [x] NIP-12 (Generic Tag Queries) 17 | - [x] NIP-33 (Parameterized Replaceable Events) 18 | - [x] NIP-42 (Authentication of clients to relays) 19 | - [x] NIP-45 (Counting results) 20 | - [x] NIP-50 (Search Capability) 21 | - [x] NIP-95 (Shared File) 22 | - [x] NIP-96 (HTTP File Storage Integration) 23 | - [x] NIP-98 (HTTP Auth) 24 | 25 | ## Implement 26 | 27 | | Function | Cloudflare implement | 28 | |---------------------|----------------------| 29 | | Event Store | D1 | 30 | | File Store (NIP-95) | KV | 31 | | File Store (NIP-96) | R2 | 32 | 33 | Why do we use the KV to save the file store? 34 | 35 | Because the R2 must bing the payment method and when it run out of the free plan limit, it would make some fee. 36 | 37 | ## Deploy 38 | 39 | ### Deploy by Cloudflare and Github 40 | 41 | [![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https%3A%2F%2Fgithub.com%2Fhaorendashu%2Fcfrelay) 42 | 43 | #### 1. Add Github Connection 44 | 45 | #### 2. Change Environment Variables 46 | 47 | Change ```OWNER``` TO Your plain Pubkey. 48 | 49 | Change ```NIP05_USERS_TEXT``` for your NIP05. (Optional) 50 | 51 | #### 3. Just Tap ```Create and deploy``` button 52 | 53 | ### Deploy by NPM and wrangler 54 | 55 | #### 1. Install NPM 56 | 57 | #### 2. Install wrangler 58 | 59 | #### 3. Init D1 database 60 | 61 | create d1 database 62 | 63 | ```bash 64 | wrangler d1 create relay 65 | ``` 66 | 67 | run init script 68 | 69 | ```bash 70 | wrangler d1 execute relay --file=init.sql 71 | ``` 72 | 73 | #### 4.Init KV 74 | 75 | ```bash 76 | wrangler kv:namespace create relay 77 | ``` 78 | 79 | #### 5.Init R2 (Optional) 80 | 81 | **If you want to use R2, you must config your payment to cloudflare. I can't ensure that it won't cost you money** 82 | 83 | After config payment, you can init the R2 bucket now. You can do it in the cloudflare website or run this script: 84 | 85 | ```bash 86 | wrangler r2 bucket create relay 87 | ``` 88 | 89 | **It is important that config a custom domain for your bucket. Due to this domain can user cloudflare's cache and it will save you money.** 90 | 91 | You can readmore from this [Connect a bucket to a custom domain 92 | ](https://developers.cloudflare.com/r2/buckets/public-buckets/#connect-a-bucket-to-a-custom-domain). 93 | 94 | #### 5.Change Config file 95 | 96 | change the owners in in ```wrangler.toml```, chenge the ```29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07``` to you ```plain owner id```. 97 | 98 | ``` toml 99 | OWNER = "29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07" 100 | ``` 101 | 102 | ```(Optional)```. change the nip05 config 103 | 104 | ``` toml 105 | // nip05 user config should set like this: 106 | NIP05_USERS_TEXT = '{"dashu": "29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07"}' 107 | ``` 108 | 109 | ```(Optional)```. If you use R2 for NIP-96 and had config a custom domain, you should config r2CustomDomain in ```wrangler.toml```. 110 | 111 | ``` toml 112 | R2_CUSTOM_DOMAIN = "You custom domain like: https://xxxxxx.com "; 113 | ``` 114 | 115 | change config file wrangler.toml set the database_id and kv_namespaces' id 116 | 117 | ```toml 118 | [[d1_databases]] 119 | binding = "DB" 120 | database_name = "relay" 121 | database_id = "Here is there d1 id" 122 | 123 | [[kv_namespaces]] 124 | binding = "KV" 125 | id = "Here is there kv id" 126 | ``` 127 | 128 | ```(Optional)```. If you use R2 for NIP-96, you should also add this setting to wrangler.toml. 129 | 130 | ```toml 131 | [[d1_databases]] 132 | [[r2_buckets]] 133 | binding = "R2" 134 | bucket_name = "You bucket name" 135 | ``` 136 | 137 | #### 6.Deploy 138 | 139 | run this script to install project dependent 140 | 141 | ```bash 142 | npm install 143 | ``` 144 | 145 | run this script to deploy 146 | 147 | ```bash 148 | npm run deploy 149 | ``` 150 | -------------------------------------------------------------------------------- /wrangler.toml: -------------------------------------------------------------------------------- 1 | #:schema node_modules/wrangler/config-schema.json 2 | name = "cfrelay" 3 | main = "src/index.js" 4 | compatibility_date = "2024-04-05" 5 | compatibility_flags = ["nodejs_compat"] 6 | 7 | [[d1_databases]] 8 | binding = "DB" 9 | database_name = "relay" 10 | database_id = "" 11 | 12 | [[kv_namespaces]] 13 | binding = "KV" 14 | id = "" 15 | 16 | # If you use the R2 for NIP-96, you should config this setting. 17 | # [[r2_buckets]] 18 | # binding = "R2" 19 | # bucket_name = "relay" 20 | 21 | [vars] 22 | OWNER = "29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07" 23 | NIP05_USERS_TEXT = '{"dashu": "29320975df855fe34a7b45ada2421e2c741c37c0136901fe477133a91eb18b07"}' 24 | R2_CUSTOM_DOMAIN = "null" 25 | 26 | # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables) 27 | # Note: Use secrets to store sensitive data. 28 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables 29 | # [vars] 30 | # MY_VARIABLE = "production_value" 31 | 32 | # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network 33 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai 34 | # [ai] 35 | # binding = "AI" 36 | 37 | # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function. 38 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets 39 | # [[analytics_engine_datasets]] 40 | # binding = "MY_DATASET" 41 | 42 | # Bind a headless browser instance running on Cloudflare's global network. 43 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering 44 | # [browser] 45 | # binding = "MY_BROWSER" 46 | 47 | # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database. 48 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases 49 | # [[d1_databases]] 50 | # binding = "MY_DB" 51 | # database_name = "my-database" 52 | # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 53 | 54 | # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers. 55 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms 56 | # [[dispatch_namespaces]] 57 | # binding = "MY_DISPATCHER" 58 | # namespace = "my-namespace" 59 | 60 | # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model. 61 | # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps. 62 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects 63 | # [[durable_objects.bindings]] 64 | # name = "MY_DURABLE_OBJECT" 65 | # class_name = "MyDurableObject" 66 | 67 | # Durable Object migrations. 68 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations 69 | # [[migrations]] 70 | # tag = "v1" 71 | # new_classes = ["MyDurableObject"] 72 | 73 | # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers. 74 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive 75 | # [[hyperdrive]] 76 | # binding = "MY_HYPERDRIVE" 77 | # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" 78 | 79 | # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs. 80 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces 81 | # [[kv_namespaces]] 82 | # binding = "MY_KV_NAMESPACE" 83 | # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" 84 | 85 | # Bind an mTLS certificate. Use to present a client certificate when communicating with another service. 86 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates 87 | # [[mtls_certificates]] 88 | # binding = "MY_CERTIFICATE" 89 | # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 90 | 91 | # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer. 92 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues 93 | # [[queues.producers]] 94 | # binding = "MY_QUEUE" 95 | # queue = "my-queue" 96 | 97 | # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them. 98 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues 99 | # [[queues.consumers]] 100 | # queue = "my-queue" 101 | 102 | # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files. 103 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets 104 | # [[r2_buckets]] 105 | # binding = "MY_BUCKET" 106 | # bucket_name = "my-bucket" 107 | 108 | # Bind another Worker service. Use this binding to call another Worker without network overhead. 109 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings 110 | # [[services]] 111 | # binding = "MY_SERVICE" 112 | # service = "my-service" 113 | 114 | # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases. 115 | # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes 116 | # [[vectorize]] 117 | # binding = "MY_INDEX" 118 | # index_name = "my-index" 119 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Welcome to Cloudflare Workers! This is your first worker. 3 | * 4 | * - Run `npm run dev` in your terminal to start a development server 5 | * - Open a browser tab at http://localhost:8787/ to see your worker in action 6 | * - Run `npm run deploy` to publish your worker 7 | * 8 | * Learn more at https://developers.cloudflare.com/workers/ 9 | */ 10 | import {bytesToHex} from '@noble/hashes/utils' 11 | import { sha256 } from '@noble/hashes/sha256' 12 | import { schnorr } from '@noble/curves/secp256k1' 13 | import { decode as base64Decode } from 'js-base64'; 14 | 15 | let utf8Encoder = new TextEncoder() 16 | 17 | const EVENT_KIND = { 18 | "EVENT_DELETION": 5, 19 | "STORAGE_SHARED_FILE": 1064, 20 | } 21 | 22 | const MAX_FILTER_LIMIT = 60; 23 | 24 | const owners = []; 25 | 26 | const relayInfo = { 27 | "name": "cfrelay", 28 | "description": "A relay run at cloudflare.", 29 | "pubkey": "", 30 | "software": "https://github.com/haorendashu/cfrelay", 31 | "supported_nips": [1, 2, 5, 9, 11, 12, 16, 33, 42, 45, 50, 95, 96], 32 | "version": "0.0.4", 33 | } 34 | 35 | const relayInfoHeader = new Headers({ 36 | "Content-Type": "application/nostr+json", 37 | }); 38 | 39 | const jsonHeader = new Headers({ 40 | "Access-Control-Allow-Origin": "*", 41 | "Access-Control-Allow-Methods": "GET, POST, PUT", 42 | "Access-Control-Allow-Headers": "Upgrade, Accept, Content-Type, User-Agent", 43 | "Access-Control-Allow-Credentials": "true", 44 | "Content-Type": "application/json", 45 | }); 46 | 47 | const corsHeader = new Headers({ 48 | "Access-Control-Allow-Origin": "*", 49 | "Access-Control-Allow-Methods": "GET, POST, PUT", 50 | "Access-Control-Allow-Headers": "Upgrade, Accept, Content-Type, User-Agent", 51 | "Access-Control-Allow-Credentials": "true", 52 | }); 53 | 54 | const nip96Info = { 55 | "api_url": "http://127.0.0.1:8787/api/nip96/upload", 56 | "supported_nips": [94, 96, 98], 57 | "content_types": ["image/*", "video/*", "audio/*"], 58 | "plans": { 59 | "free": { 60 | "name": "Free", 61 | "is_nip98_required": true, 62 | "max_byte_size": 10485760, 63 | "file_expiration": [0, 0], 64 | "media_transformations": {} 65 | } 66 | } 67 | }; 68 | 69 | const nip98AuthJsonStr = '{"status":"error","message":"NIP-98 check fail."}'; 70 | 71 | const API_FAIL = "fail"; 72 | function buildApiResult(status, message) { 73 | if (!status) { 74 | status = 'success'; 75 | } 76 | if (!message) { 77 | message = 'success'; 78 | } 79 | 80 | return { 81 | "status": status, 82 | "message": message, 83 | } 84 | } 85 | 86 | function checkOwner(env, pubkey) { 87 | if (pubkey == env.OWNER) { 88 | return true; 89 | } 90 | return owners.includes(pubkey); 91 | } 92 | 93 | export default { 94 | async fetch(request, env, ctx) { 95 | if (request.headers.get('Upgrade') === 'websocket') { 96 | // websocket connection 97 | const [client, server] = Object.values(new WebSocketPair()); 98 | await handleSession(env, server); 99 | 100 | return new Response(null, { 101 | status: 101, 102 | webSocket: client, 103 | }); 104 | } else if (request.method == 'OPTIONS') { 105 | // handle cors 106 | return new Response("", { 107 | status: 200, headers: corsHeader, 108 | }); 109 | } else if (request.headers.get('Accept') == 'application/nostr+json') { 110 | // return relay info 111 | relayInfo["pubkey"] = env.OWNER; 112 | const relayInfoJsonStr = JSON.stringify(relayInfo); 113 | return new Response(relayInfoJsonStr, { 114 | status: 200, headers: relayInfoHeader, 115 | }); 116 | } 117 | 118 | const url = new URL(request.url); 119 | if (url.pathname == '/.well-known/nostr.json') { 120 | // return nip05 info 121 | const nip05UserJsonStr = '{"names":' + env.NIP05_USERS_TEXT + '}'; 122 | return new Response(nip05UserJsonStr, { 123 | status: 200, headers: jsonHeader, 124 | }); 125 | } else if (url.pathname == '/.well-known/nostr/nip96.json') { 126 | // return nip96 info 127 | nip96Info['api_url'] = getRequestHost(request) + '/api/nip96/upload'; 128 | return new Response(JSON.stringify(nip96Info), { 129 | status: 200, headers: jsonHeader, 130 | }); 131 | } else if (url.pathname == '/api/nip96/upload') { 132 | // handle nip96 upload method 133 | let nip98Result = verifyNip98(env, request); 134 | if (nip98Result != null) { 135 | return nip98Result; 136 | } 137 | 138 | return await handleNip96Upload(env, request); 139 | } else if (url.pathname.startsWith('/nip96images/')) { 140 | // ** This is method only use for dev, don't use it for your public access. ** 141 | // handle nip96 download method 142 | return await handleNip96Download(env, request, url.pathname); 143 | } 144 | 145 | return new Response('A relay run at cloudflare.'); 146 | }, 147 | }; 148 | 149 | async function handleSession(env, websocket) { 150 | let isOwner = false; 151 | let authed = false; 152 | let authedPubkey; 153 | let challengeStr = generateRandomString(12); 154 | 155 | let messageHandling = 0; 156 | 157 | websocket.accept(); 158 | websocket.addEventListener('message', async (wsEvent) => { 159 | try { 160 | if (wsEvent.data == 'ping') { 161 | websocket.send('pong'); 162 | return; 163 | } 164 | 165 | // console.log(wsEvent.data); 166 | const message = JSON.parse(wsEvent.data); 167 | 168 | const typ = message[0]; 169 | if (typ == 'REQ') { 170 | messageHandling++; 171 | if (messageHandling > 5 && !isOwner) { 172 | sendNotice(websocket, "Too fast! Slow down please!") 173 | return; 174 | } 175 | 176 | await doReq(env, websocket, message, isOwner) 177 | } else if (typ == 'EVENT') { 178 | let event = message[1]; 179 | 180 | if (!isOwner) { 181 | websocket.send('["OK","'+event.id+'",false,"Only the authed owner can send events."]'); 182 | return; 183 | } 184 | if (event.pubkey != authedPubkey) { 185 | // The owner login but this isn't owner's event, so just ignore it. 186 | // websocket.send('["OK","'+event.id+'",false,"Only the owner can send events."]'); 187 | return; 188 | } 189 | 190 | // due to this event is sended from owner, we don't valid the sig. 191 | await doEvent(env, websocket, event); 192 | await websocket.send('["OK","'+event.id+'",true,""]'); 193 | } else if (typ == 'CLOSE') { 194 | // we haven't holder subscription and push, so just ignore the close message. 195 | } else if (typ == 'AUTH') { 196 | let pubkey = doAuth(websocket, message, challengeStr); 197 | if (pubkey != null) { 198 | console.log("doAuth result " + pubkey); 199 | authed = true; 200 | authedPubkey = pubkey; 201 | if (checkOwner(env, pubkey)) { 202 | isOwner = true; 203 | } 204 | } else { 205 | sendNotice("Auth fail"); 206 | } 207 | } else if (typ == 'COUNT') { 208 | await doCount(env, websocket, message); 209 | } else { 210 | 211 | } 212 | } catch (e) { 213 | console.log(e); 214 | } finally { 215 | messageHandling--; 216 | } 217 | }); 218 | 219 | websocket.addEventListener('close', async evt => { 220 | // Handle when a client closes the WebSocket connection 221 | console.log(evt); 222 | }); 223 | 224 | websocket.send('["AUTH","'+challengeStr+'"]') 225 | } 226 | 227 | function sendNotice(websocket, msg) { 228 | websocket.send('["NOTICE","'+msg+'"]'); 229 | } 230 | 231 | async function doReq(env, websocket, message, isOwner) { 232 | if (message.length > 2) { 233 | let subscriptionId = message[1]; 234 | 235 | for (let i = 2; i < message.length; i++) { 236 | let filter = message[i]; 237 | let events = await doQueryEvent(env, filter); 238 | for (let j = 0; j < events.length; j++) { 239 | let event = events[j]; 240 | if (!isOwner && (event.kind == 4 || event.kind == 1059)) { 241 | // only the owner can receive DM and GiftWrap event 242 | continue; 243 | } 244 | 245 | // due to tags save to db had be encoded to jsonStr, so it must be decoded to json here 246 | let tagsStr = event.tags; 247 | if (typeof tagsStr == 'string') { 248 | event.tags = JSON.parse(tagsStr); 249 | } 250 | 251 | if (event.kind === EVENT_KIND.STORAGE_SHARED_FILE) { 252 | // NIP-95 event, load the content from KV or R2 (not implement) 253 | let content = await env.KV.get(event.id); 254 | // send to client by string combine avoid json encode 255 | let eventStr = JSON.stringify(event, ['id', 'pubkey', 'created_at', 'kind', 'tags', 'sig']); 256 | await websocket.send('["EVENT","'+subscriptionId+'",{"content":"'+content+'",'+eventStr.substring(1)+']'); 257 | continue 258 | } 259 | 260 | await websocket.send(JSON.stringify(["EVENT", subscriptionId, event])); 261 | } 262 | } 263 | 264 | await websocket.send('["EOSE","'+subscriptionId+'"]'); 265 | } 266 | } 267 | 268 | async function doCount(env, websocket, message) { 269 | if (message.length > 2) { 270 | let subscriptionId = message[1]; 271 | let filter = message[2]; 272 | 273 | let count = await doQueryCount(env, filter); 274 | await websocket.send('["COUNT","'+subscriptionId+'",'+count+']'); 275 | } 276 | } 277 | 278 | async function doQueryEvent(env, filter) { 279 | let params = []; 280 | let sql = queryEventsSql(filter, false, params); 281 | console.log(sql); 282 | console.log(params); 283 | const { results } = await env.DB.prepare(sql).bind(...params).all(); 284 | return results; 285 | } 286 | 287 | async function doQueryCount(env, filter) { 288 | let params = []; 289 | let sql = queryEventsSql(filter, true, params); 290 | console.log(sql); 291 | return await env.DB.prepare(sql).bind(...params).first('total'); 292 | } 293 | 294 | function queryEventsSql(filter, doCount, params) { 295 | let conditions = []; 296 | 297 | let key = 'ids'; 298 | if (filter[key] != null && filter[key] instanceof Array && filter[key].length > 0) { 299 | params.push.apply(params, filter[key]); 300 | conditions.push('id IN('+makePlaceHolders(filter[key].length)+')') 301 | filter[key] = null; 302 | } 303 | 304 | key = 'authors'; 305 | if (filter[key] != null && filter[key] instanceof Array && filter[key].length > 0) { 306 | params.push.apply(params, filter[key]); 307 | conditions.push('pubkey IN('+makePlaceHolders(filter[key].length)+')') 308 | filter[key] = null; 309 | } 310 | 311 | key = 'kinds'; 312 | let limit1Kind = false; 313 | if (filter[key] != null && filter[key] instanceof Array && filter[key].length > 0) { 314 | if (filter[key].length == 1) { 315 | let kind = filter[key][0]; 316 | // these kind event should only return 1 event back. 317 | if (kind == 0 || kind == 3 || kind == 10002) { 318 | limit1Kind = true; 319 | } 320 | } 321 | 322 | params.push.apply(params, filter[key]); 323 | conditions.push('kind IN('+makePlaceHolders(filter[key].length)+')') 324 | filter[key] = null; 325 | } 326 | 327 | key = 'since'; 328 | let since = filter[key]; 329 | if (since != null) { 330 | conditions.push('created_at >= ?'); 331 | params.push(since); 332 | } 333 | filter[key] = null; 334 | 335 | key = 'until'; 336 | let until = filter[key]; 337 | if (until != null) { 338 | conditions.push('created_at <= ?'); 339 | params.push(until); 340 | } 341 | filter[key] = null; 342 | 343 | key = 'search'; 344 | let search = filter[key]; 345 | if (search != null && typeof search == 'string') { 346 | conditions.push('content LIKE ? ESCAPE "\\"'); 347 | params.push('%'+search.replaceAll('%', '\%')+'%'); 348 | } 349 | filter[key] = null; 350 | 351 | let tagQuery = []; 352 | for (let k in filter) { 353 | let v = filter[k]; 354 | if (k != 'limit' && v != null) { 355 | v.forEach(function(vItem) { 356 | if (vItem.length > 10) { 357 | tagQuery.push('\"'+k.replaceAll('#', "")+'\",\"' + getMaxString(vItem, 30)); 358 | } else { 359 | tagQuery.push('\"'+k.replaceAll('#', "")+'\",\"' + vItem); 360 | } 361 | }) 362 | } 363 | } 364 | for (let index in tagQuery) { 365 | let tagValue = tagQuery[index]; 366 | conditions.push('tags LIKE ? ESCAPE "\\"'); 367 | params.push('%'+tagValue.replaceAll('%', '\%')+'%'); 368 | } 369 | 370 | if (conditions.length == 0) { 371 | conditions.push("true"); 372 | } 373 | 374 | let limit = filter['limit']; 375 | if (limit != null && limit > 0) { 376 | if (limit > MAX_FILTER_LIMIT) { 377 | limit = MAX_FILTER_LIMIT; 378 | } 379 | params.push(limit); 380 | } else { 381 | if (limit1Kind) { 382 | params.push(1); // only return 1 event back 383 | } else { 384 | params.push(MAX_FILTER_LIMIT); // This is a default num. 385 | } 386 | } 387 | 388 | if (doCount) { 389 | return 'SELECT COUNT(*) as total FROM event WHERE '+ conditions.join(' And ') +' ORDER BY created_at DESC LIMIT ?'; 390 | } 391 | 392 | return 'SELECT id, pubkey, created_at, kind, tags, content, sig FROM event WHERE '+ conditions.join(' And ') +' ORDER BY created_at DESC LIMIT ?' 393 | } 394 | 395 | function getMaxString(inputString, num) { 396 | if (inputString.length > num) { 397 | return inputString.slice(0, num); 398 | } 399 | return inputString; 400 | } 401 | 402 | function makePlaceHolders(n) { 403 | if (n == 1) { 404 | return "?"; 405 | } 406 | 407 | let arrs = new Array(n - 1); 408 | arrs.fill('?'); 409 | return arrs.join(',') + ',?'; 410 | } 411 | 412 | async function doEvent(env, websocket, event) { 413 | if (event.kind === EVENT_KIND.EVENT_DELETION) { 414 | // delete event 415 | let tagsLength = event.tags.length; 416 | for (let index = 0; index < tagsLength; index++) { 417 | let tag = event.tags[index]; 418 | if (tag.length > 1) { 419 | let k = tag[0]; 420 | let v = tag[1]; 421 | if (k == "e") { 422 | const result = await env.DB.prepare("delete from event where id = ? and pubkey = ?").bind(v, event.pubkey).run(); 423 | console.log("delete result: "); 424 | console.log(result); 425 | // try to delete kv 426 | try { 427 | await env.KV.delete(v); 428 | } catch (e) {} 429 | } 430 | } 431 | } 432 | 433 | return; 434 | } else if (event.kind === EVENT_KIND.STORAGE_SHARED_FILE) { 435 | // NIP-95 file, save to content to store: KV or R2 (not implement) 436 | let content = event.content; 437 | console.log(content) 438 | let result = await env.KV.put(event.id, content); 439 | console.log(result) 440 | 441 | // clean the content 442 | event.content = ""; 443 | } 444 | 445 | // base event 446 | let tags = event.tags; 447 | if (tags !== null) { 448 | event.tags = JSON.stringify(tags); 449 | try { 450 | // maybe the event is existing. 451 | const result = await env.DB.prepare("insert into event(id, pubkey, created_at, kind, tags, content, sig) values (?, ?, ?, ?, ?, ?, ?)").bind(event.id, event.pubkey, event.created_at, event.kind, event.tags, event.content, event.sig).run(); 452 | console.log("insert result: "); 453 | console.log(result); 454 | } catch (e) { 455 | } 456 | } 457 | } 458 | 459 | // check the auth message and return the pubkey 460 | function doAuth(websocket, message, challengeStr) { 461 | if (message.length > 1) { 462 | let event = message[1]; 463 | if (event.tags != null) { 464 | for (let i = 0; i < event.tags.length; i++) { 465 | let tag = event.tags[i]; 466 | if (tag != null && tag.length > 1) { 467 | let k = tag[0]; 468 | let v = tag[1]; 469 | if (k == 'challenge' && v == challengeStr) { 470 | if (verifyEvent(event)) { 471 | return event.pubkey; 472 | } 473 | } 474 | } 475 | } 476 | } 477 | } 478 | 479 | return null; 480 | } 481 | 482 | function verifyEvent(event) { 483 | const hash = getEventHash(event) 484 | if (hash !== event.id) { 485 | return false 486 | } 487 | 488 | try { 489 | return schnorr.verify(event.sig, hash, event.pubkey) 490 | } catch (err) { 491 | return false 492 | } 493 | } 494 | 495 | function getEventHash(event) { 496 | let eventHash = sha256(utf8Encoder.encode(serializeEvent(event))) 497 | return bytesToHex(eventHash) 498 | } 499 | 500 | function serializeEvent(event) { 501 | return JSON.stringify([0, event.pubkey, event.created_at, event.kind, event.tags, event.content]); 502 | } 503 | 504 | function generateRandomString(length) { 505 | let result = ''; 506 | const charactersLength = length; 507 | 508 | for (let i = 0; i < length; i++) { 509 | const randomValue = Math.floor((Date.now() * Math.random()) % charactersLength); 510 | result += String.fromCharCode(randomValue + 65); 511 | } 512 | 513 | return result; 514 | } 515 | 516 | function getRequestHost(request) { 517 | const url = new URL(request.url); 518 | return url.origin; 519 | } 520 | 521 | // check if the reqeust nip98 auth success and if the pubkey is owner. 522 | // success return null. 523 | // fail return a http response. 524 | function verifyNip98(env, request) { 525 | let authorText = request.headers.get('Authorization'); 526 | if (authorText != null) { 527 | authorText = authorText.replaceAll("Nostr ", "") 528 | let authEventText = base64Decode(authorText); 529 | const authEvent = JSON.parse(authEventText); 530 | 531 | if (verifyEvent(authEvent)) { 532 | // authEvent check success 533 | // check the owner 534 | if (checkOwner(env, authEvent.pubkey)) { 535 | // it's owner request 536 | return null; 537 | } 538 | } 539 | } 540 | 541 | return new Response(nip98AuthJsonStr, { 542 | status: 200, headers: jsonHeader, 543 | }); 544 | } 545 | 546 | function getNip96DownloadUrl(env, request, fullFilename) { 547 | if (env.R2_CUSTOM_DOMAIN && env.R2_CUSTOM_DOMAIN != '' && env.R2_CUSTOM_DOMAIN != 'null') { 548 | return env.R2_CUSTOM_DOMAIN + '/' + fullFilename; 549 | } 550 | 551 | return getRequestHost(request) + '/nip96images/' + fullFilename; 552 | } 553 | 554 | async function handleNip96Upload(env, request) { 555 | let formData = await request.formData(); 556 | let file = formData.get('file'); 557 | 558 | let filename = file.name; 559 | let extension = ''; 560 | if (filename) { 561 | let filenameStrs = filename.split('.') 562 | extension = filenameStrs[filenameStrs.length - 1]; 563 | } 564 | if (extension == '') { 565 | let contentType = request.headers.get('Content-Type'); 566 | let contentTypeStrs = contentType.split('/'); 567 | let ct = contentTypeStrs[0]; 568 | if (ct == 'image') { 569 | extension = 'jpg'; 570 | } else if (ct == 'video') { 571 | extension = 'mp4'; 572 | } else if (ct == 'audio') { 573 | extension = 'mp3'; 574 | } 575 | } 576 | if (extension != '') { 577 | extension = '.' + extension; 578 | } 579 | 580 | let data = await file.arrayBuffer(); 581 | let ox = bytesToHex(await sha256(new Uint8Array(data))); 582 | 583 | let fullFilename = ox + extension; 584 | 585 | await env.R2.put(fullFilename, data); 586 | let url = getNip96DownloadUrl(env, request, fullFilename); 587 | 588 | let nip94Event = { 589 | "tags": [ 590 | ["url", url], 591 | ["ox", ox] 592 | ], 593 | content: "" 594 | }; 595 | 596 | let result = buildApiResult(null, 'Upload successful.'); 597 | result['nip94_event'] = nip94Event; 598 | 599 | return new Response(JSON.stringify(result), { 600 | status: 200, headers: jsonHeader, 601 | }); 602 | } 603 | 604 | async function handleNip96Download(env, request, pathname) { 605 | let filename = pathname.replaceAll('/nip96images/', ''); 606 | let filenameStrs = filename.split('.'); 607 | let key = filenameStrs[0]; 608 | 609 | const object = await env.R2.get(key); 610 | if (!object) { 611 | return new Response('File not found.', { 612 | status: 400, 613 | }); 614 | } 615 | 616 | const headers = new Headers(); 617 | object.writeHttpMetadata(headers); 618 | headers.set('etag', object.httpEtag); 619 | 620 | return new Response(object.body, { 621 | headers, 622 | }); 623 | } 624 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------