├── simple ├── src │ ├── react-app-env.d.ts │ ├── setupTests.ts │ ├── App.test.tsx │ ├── index.css │ ├── index.tsx │ ├── App.css │ ├── code-block.js │ ├── signal-directory.ts │ ├── logo.svg │ ├── serviceWorker.ts │ ├── storage-type.ts │ └── App.tsx ├── public │ ├── robots.txt │ ├── favicon.ico │ ├── logo192.png │ ├── logo512.png │ ├── manifest.json │ ├── send-message.md │ ├── createid.md │ ├── start-session-with-b.md │ ├── index.html │ └── start-session-with-a.md ├── craco.config.js ├── prettier.config.js ├── .gitignore ├── tsconfig.json ├── README.md ├── package.json └── LICENSE.md ├── signal-protocol-client ├── src │ ├── react-app-env.d.ts │ ├── messages │ │ ├── types.ts │ │ ├── ui │ │ │ ├── message-view.tsx │ │ │ ├── message-list.tsx │ │ │ └── compose-message.tsx │ │ ├── api.ts │ │ └── functions.ts │ ├── network │ │ ├── state.ts │ │ ├── types.ts │ │ └── websocket.ts │ ├── sessions │ │ ├── types.ts │ │ ├── state.ts │ │ ├── ui │ │ │ ├── session-list.tsx │ │ │ ├── add-session.tsx │ │ │ ├── session-summary.tsx │ │ │ └── session-details.tsx │ │ └── functions.ts │ ├── setupTests.ts │ ├── App.test.tsx │ ├── identity │ │ ├── state.ts │ │ ├── functions.ts │ │ └── ui │ │ │ └── create-identity.tsx │ ├── index.css │ ├── App.css │ ├── hooks │ │ └── index.ts │ ├── reportWebVitals.ts │ ├── index.tsx │ ├── App.tsx │ ├── logo.svg │ └── signal │ │ ├── signal-directory.ts │ │ └── signal-store.ts ├── public │ ├── robots.txt │ ├── favicon.ico │ ├── logo192.png │ ├── logo512.png │ ├── manifest.json │ └── index.html ├── craco.config.js ├── prettier.config.js ├── .gitignore ├── tsconfig.json ├── package.json ├── README.md └── LICENSE.md └── README.md /simple/src/react-app-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /signal-protocol-client/src/react-app-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /simple/public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /signal-protocol-client/public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /simple/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/privacyresearchgroup/libsignal-typescript-demo/HEAD/simple/public/favicon.ico -------------------------------------------------------------------------------- /simple/public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/privacyresearchgroup/libsignal-typescript-demo/HEAD/simple/public/logo192.png -------------------------------------------------------------------------------- /simple/public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/privacyresearchgroup/libsignal-typescript-demo/HEAD/simple/public/logo512.png -------------------------------------------------------------------------------- /signal-protocol-client/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/privacyresearchgroup/libsignal-typescript-demo/HEAD/signal-protocol-client/public/favicon.ico -------------------------------------------------------------------------------- /signal-protocol-client/public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/privacyresearchgroup/libsignal-typescript-demo/HEAD/signal-protocol-client/public/logo192.png -------------------------------------------------------------------------------- /signal-protocol-client/public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/privacyresearchgroup/libsignal-typescript-demo/HEAD/signal-protocol-client/public/logo512.png -------------------------------------------------------------------------------- /signal-protocol-client/src/messages/types.ts: -------------------------------------------------------------------------------- 1 | export interface ProcessedChatMessage { 2 | id: string 3 | address: string 4 | from: string 5 | timestamp: number 6 | body: string 7 | } 8 | -------------------------------------------------------------------------------- /signal-protocol-client/src/network/state.ts: -------------------------------------------------------------------------------- 1 | 2 | import { BehaviorSubject } from 'rxjs' 3 | import { NetworkParams } from './types' 4 | 5 | export const networkInfoSubject = new BehaviorSubject(null) 6 | -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/types.ts: -------------------------------------------------------------------------------- 1 | import { ProcessedChatMessage } from '@app/messages/types' 2 | 3 | export interface ChatSession { 4 | remoteUsername: string 5 | messages: ProcessedChatMessage[] 6 | } 7 | -------------------------------------------------------------------------------- /signal-protocol-client/src/setupTests.ts: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import '@testing-library/jest-dom' 6 | -------------------------------------------------------------------------------- /simple/src/setupTests.ts: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import '@testing-library/jest-dom/extend-expect'; 6 | -------------------------------------------------------------------------------- /simple/craco.config.js: -------------------------------------------------------------------------------- 1 | const path = require('path') 2 | 3 | module.exports = { 4 | webpack: { 5 | alias: { '@app': path.resolve(__dirname, './src') }, 6 | configure: { 7 | resolve: { 8 | fallback: { 9 | fs: false, 10 | path: false, 11 | }, 12 | }, 13 | }, 14 | }, 15 | } 16 | -------------------------------------------------------------------------------- /simple/src/App.test.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { render } from '@testing-library/react'; 3 | import App from './App'; 4 | 5 | test('renders learn react link', () => { 6 | const { getByText } = render(); 7 | const linkElement = getByText(/learn react/i); 8 | expect(linkElement).toBeInTheDocument(); 9 | }); 10 | -------------------------------------------------------------------------------- /signal-protocol-client/src/App.test.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import { render, screen } from '@testing-library/react' 3 | import App from './App' 4 | 5 | test('renders learn react link', () => { 6 | render() 7 | const linkElement = screen.getByText(/learn react/i) 8 | expect(linkElement).toBeInTheDocument() 9 | }) 10 | -------------------------------------------------------------------------------- /signal-protocol-client/craco.config.js: -------------------------------------------------------------------------------- 1 | const path = require('path') 2 | 3 | module.exports = { 4 | webpack: { 5 | alias: { '@app': path.resolve(__dirname, './src') }, 6 | configure: { 7 | resolve: { 8 | fallback: { 9 | fs: false, 10 | path: false, 11 | }, 12 | }, 13 | }, 14 | }, 15 | } 16 | -------------------------------------------------------------------------------- /simple/prettier.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | tabWidth: 4, 3 | printWidth: 120, 4 | proseWrap: 'preserve', 5 | semi: false, 6 | trailingComma: 'es5', 7 | singleQuote: true, 8 | overrides: [ 9 | { 10 | files: '{*.js?(on),*.md,.prettierrc,.babelrc}', 11 | options: { 12 | tabWidth: 2, 13 | }, 14 | }, 15 | ], 16 | } 17 | -------------------------------------------------------------------------------- /signal-protocol-client/prettier.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | tabWidth: 4, 3 | printWidth: 120, 4 | proseWrap: 'preserve', 5 | semi: false, 6 | trailingComma: 'es5', 7 | singleQuote: true, 8 | overrides: [ 9 | { 10 | files: '{*.js?(on),*.md,.prettierrc,.babelrc}', 11 | options: { 12 | tabWidth: 2, 13 | }, 14 | }, 15 | ], 16 | } 17 | -------------------------------------------------------------------------------- /simple/.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | node_modules/ 5 | 6 | # testing 7 | coverage/ 8 | 9 | # production 10 | build/ 11 | 12 | # misc 13 | .DS_Store 14 | .env.local 15 | .env.development.local 16 | .env.test.local 17 | .env.production.local 18 | 19 | npm-debug.log* 20 | yarn-debug.log* 21 | yarn-error.log* 22 | -------------------------------------------------------------------------------- /signal-protocol-client/src/identity/state.ts: -------------------------------------------------------------------------------- 1 | import { SignalProtocolStore } from '@app/signal/signal-store' 2 | import { BehaviorSubject } from 'rxjs' 3 | import { SignalDirectory } from '../signal/signal-directory' 4 | 5 | export const directorySubject = new BehaviorSubject(null) 6 | export const signalStore = new SignalProtocolStore() 7 | export const usernameSubject = new BehaviorSubject('') 8 | -------------------------------------------------------------------------------- /simple/src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 4 | 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 5 | sans-serif; 6 | -webkit-font-smoothing: antialiased; 7 | -moz-osx-font-smoothing: grayscale; 8 | } 9 | 10 | code { 11 | font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', 12 | monospace; 13 | } 14 | -------------------------------------------------------------------------------- /signal-protocol-client/.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | node_modules/ 5 | 6 | # testing 7 | coverage/ 8 | 9 | # production 10 | build/ 11 | 12 | # misc 13 | .DS_Store 14 | .env.local 15 | .env.development.local 16 | .env.test.local 17 | .env.production.local 18 | 19 | npm-debug.log* 20 | yarn-debug.log* 21 | yarn-error.log* 22 | 23 | networkinfo.txt -------------------------------------------------------------------------------- /signal-protocol-client/src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 4 | 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 5 | sans-serif; 6 | -webkit-font-smoothing: antialiased; 7 | -moz-osx-font-smoothing: grayscale; 8 | } 9 | 10 | code { 11 | font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', 12 | monospace; 13 | } 14 | -------------------------------------------------------------------------------- /signal-protocol-client/src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: left; 3 | margin-left: 10px; 4 | } 5 | .container { 6 | padding: 2px; 7 | margin-left: 20px; 8 | } 9 | 10 | .buttonitem { 11 | margin: 10px; 12 | padding: 5px; 13 | } 14 | 15 | .inputset { 16 | text-align: left; 17 | padding: 10px; 18 | margin: 10px; 19 | } 20 | 21 | .inputitem { 22 | text-align: left; 23 | padding: 5px; 24 | margin: 5px; 25 | } 26 | 27 | .label { 28 | margin-right: 10px; 29 | } -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/state.ts: -------------------------------------------------------------------------------- 1 | 2 | import { BehaviorSubject } from 'rxjs' 3 | import { ChatSession } from './types' 4 | 5 | export const sessionListSubject = new BehaviorSubject([]) 6 | export const currentSessionSubject = new BehaviorSubject(null) 7 | 8 | export function sessionForRemoteUser(username: string): ChatSession | undefined { 9 | return sessionListSubject.value.find((session) => session.remoteUsername === username) 10 | } 11 | -------------------------------------------------------------------------------- /signal-protocol-client/src/hooks/index.ts: -------------------------------------------------------------------------------- 1 | import { useState, useEffect } from 'react' 2 | import { Observable } from 'rxjs' 3 | 4 | export function useObservable(observable: Observable, initialValue: T): T { 5 | const [value, setValue] = useState(initialValue) 6 | 7 | useEffect(() => { 8 | const subscription = observable.subscribe((newValue) => { 9 | setValue(newValue) 10 | }) 11 | return () => subscription.unsubscribe() 12 | }, [observable]) 13 | 14 | return value 15 | } 16 | -------------------------------------------------------------------------------- /signal-protocol-client/src/reportWebVitals.ts: -------------------------------------------------------------------------------- 1 | import { ReportHandler } from 'web-vitals' 2 | 3 | const reportWebVitals = (onPerfEntry?: ReportHandler) => { 4 | if (onPerfEntry && onPerfEntry instanceof Function) { 5 | import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => { 6 | getCLS(onPerfEntry) 7 | getFID(onPerfEntry) 8 | getFCP(onPerfEntry) 9 | getLCP(onPerfEntry) 10 | getTTFB(onPerfEntry) 11 | }) 12 | } 13 | } 14 | 15 | export default reportWebVitals 16 | -------------------------------------------------------------------------------- /simple/src/index.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.css'; 4 | import App from './App'; 5 | import * as serviceWorker from './serviceWorker'; 6 | 7 | ReactDOM.render( 8 | 9 | 10 | , 11 | document.getElementById('root') 12 | ); 13 | 14 | // If you want your app to work offline and load faster, you can change 15 | // unregister() to register() below. Note this comes with some pitfalls. 16 | // Learn more about service workers: https://bit.ly/CRA-PWA 17 | serviceWorker.unregister(); 18 | -------------------------------------------------------------------------------- /simple/public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /signal-protocol-client/public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /signal-protocol-client/src/messages/ui/message-view.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import { ProcessedChatMessage } from '../types' 3 | 4 | 5 | export interface MessageViewProps { 6 | message: ProcessedChatMessage 7 | incoming: boolean 8 | } 9 | 10 | export default function MessageView(props: MessageViewProps): JSX.Element { 11 | const timeString = new Date(props.message.timestamp).toLocaleString() 12 | 13 | return ( 14 |

15 | {timeString}  16 | {props.message.from}: {props.incoming ? props.message.body : {props.message.body}} 17 |

18 | ) 19 | } 20 | -------------------------------------------------------------------------------- /signal-protocol-client/src/messages/ui/message-list.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import { ProcessedChatMessage } from '../types' 3 | 4 | import MessageView from './message-view' 5 | 6 | export interface MessageListProps { 7 | messages: ProcessedChatMessage[] 8 | remoteUserName: string 9 | } 10 | 11 | export default function MessageList(props: MessageListProps): JSX.Element { 12 | return ( 13 |
14 | {props.messages.map((m) => ( 15 | 16 | ))} 17 |
18 | ) 19 | } 20 | -------------------------------------------------------------------------------- /simple/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "lib": [ 5 | "dom", 6 | "dom.iterable", 7 | "esnext" 8 | ], 9 | "allowJs": true, 10 | "skipLibCheck": true, 11 | "esModuleInterop": true, 12 | "allowSyntheticDefaultImports": true, 13 | "strict": true, 14 | "forceConsistentCasingInFileNames": true, 15 | "module": "esnext", 16 | "moduleResolution": "node", 17 | "resolveJsonModule": true, 18 | "isolatedModules": true, 19 | "noEmit": true, 20 | "jsx": "react-jsx", 21 | "noFallthroughCasesInSwitch": true 22 | }, 23 | "include": [ 24 | "src" 25 | ] 26 | } 27 | -------------------------------------------------------------------------------- /simple/public/send-message.md: -------------------------------------------------------------------------------- 1 | ## You just sent a message. Here's what happened. 2 | 3 | First, we create a new `SessionCipher` for the recipient using our local `store`. 4 | 5 | ```ts 6 | 7 | const cipher = SessionCipher(store, recipientAddress); 8 | }; 9 | ``` 10 | 11 | Then we can encrypt the message, this time producing a `WhisperMessage`. 12 | 13 | ```ts 14 | const ciphertext = await cipher.encrypt( 15 | new TextEncoder().encode(message).buffer 16 | ); 17 | ``` 18 | 19 | And now we can send the message over any channel we like, Here `to` and `from` are 20 | addresses strings. 21 | 22 | ```ts 23 | sendMessage(to, from, ciphertext); 24 | }; 25 | ``` 26 | -------------------------------------------------------------------------------- /signal-protocol-client/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "lib": ["dom", "dom.iterable", "esnext"], 5 | "allowJs": true, 6 | "skipLibCheck": true, 7 | "esModuleInterop": true, 8 | "allowSyntheticDefaultImports": true, 9 | "strict": true, 10 | "forceConsistentCasingInFileNames": true, 11 | "noFallthroughCasesInSwitch": true, 12 | "module": "esnext", 13 | "moduleResolution": "node", 14 | "resolveJsonModule": true, 15 | "isolatedModules": true, 16 | "noEmit": true, 17 | "jsx": "react-jsx", 18 | "paths": { 19 | "@app/*": ["./src/*"] 20 | } 21 | }, 22 | "include": ["src"] 23 | } 24 | -------------------------------------------------------------------------------- /simple/src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .App-logo { 6 | height: 40vmin; 7 | pointer-events: none; 8 | } 9 | 10 | @media (prefers-reduced-motion: no-preference) { 11 | .App-logo { 12 | animation: App-logo-spin infinite 20s linear; 13 | } 14 | } 15 | 16 | .App-header { 17 | background-color: #282c34; 18 | min-height: 100vh; 19 | display: flex; 20 | flex-direction: column; 21 | align-items: center; 22 | justify-content: center; 23 | font-size: calc(10px + 2vmin); 24 | color: white; 25 | } 26 | 27 | .App-link { 28 | color: #61dafb; 29 | } 30 | 31 | @keyframes App-logo-spin { 32 | from { 33 | transform: rotate(0deg); 34 | } 35 | to { 36 | transform: rotate(360deg); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /simple/src/code-block.js: -------------------------------------------------------------------------------- 1 | 2 | import React from "react" 3 | import { Prism as SyntaxHighlighter } from "react-syntax-highlighter" 4 | import {dracula} from 'react-syntax-highlighter/dist/cjs/styles/prism'; 5 | 6 | const CodeBlock = { 7 | code({node, inline, className, children, ...props}) { 8 | const match = /language-(\w+)/.exec(className || '') 9 | return !inline && match ? ( 10 | 14 | {String(children).replace(/\n$/, '')} 15 | 16 | 17 | ) : ( 18 | 19 | {children} 20 | 21 | ) 22 | } 23 | } 24 | 25 | export default CodeBlock -------------------------------------------------------------------------------- /signal-protocol-client/src/index.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import ReactDOM from 'react-dom' 3 | import './index.css' 4 | import App from './App' 5 | import reportWebVitals from './reportWebVitals' 6 | import TimeAgo from 'javascript-time-ago' 7 | 8 | import en from 'javascript-time-ago/locale/en.json' 9 | 10 | console.log('add locale', { en }) 11 | TimeAgo.addLocale(en) 12 | TimeAgo.addDefaultLocale(en) 13 | 14 | ReactDOM.render( 15 | 16 | 17 | , 18 | document.getElementById('root') 19 | ) 20 | 21 | // If you want to start measuring performance in your app, pass a function 22 | // to log results (for example: reportWebVitals(console.log)) 23 | // or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals 24 | reportWebVitals() 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Demo React Application using the libsignal-protocol-typescript 2 | 3 | This repository contains two sample applications using [libsignal-protocol-typescript](https://github.com/privacyresearchgroup/libsignal-protocol-typescript): 4 | 5 | * `./simple/`: A simple React app that operates entirely in the client, simulating the signal directory and message passing in memory. As you use the 6 | application it provides code snippets and explanations of what is happening with each button press. This is the place to start to learn about 7 | developing applications with the Signal Protocol. 8 | * `./signal-protocol-client`: A React client chat app that communicates with a backend for directory services and message delivery. This is a slightly more realistic example that adds 9 | some state management and networking complexity. 10 | -------------------------------------------------------------------------------- /signal-protocol-client/src/network/types.ts: -------------------------------------------------------------------------------- 1 | export interface WebSocketMessage { 2 | action: 'sendMessage' | 'subscribe' | 'recent' 3 | } 4 | 5 | export interface SendWebSocketMessage extends WebSocketMessage { 6 | action: 'sendMessage' 7 | address: string 8 | from: string 9 | message: string 10 | } 11 | 12 | export interface SubscribeWebSocketMessage extends WebSocketMessage { 13 | action: 'subscribe' 14 | channels: string[] 15 | } 16 | 17 | export interface RequestRecentWebsocketMessage extends WebSocketMessage { 18 | action: 'recent' 19 | address: string 20 | } 21 | 22 | export function isSendWebSocketMessage(wsm: WebSocketMessage): wsm is SendWebSocketMessage { 23 | return wsm.action === 'sendMessage' && 'message' in wsm 24 | } 25 | 26 | export interface NetworkParams { 27 | apiURL: string 28 | wssURI: string 29 | apiKey: string 30 | } 31 | -------------------------------------------------------------------------------- /signal-protocol-client/src/network/websocket.ts: -------------------------------------------------------------------------------- 1 | import { SubscribeWebSocketMessage, WebSocketMessage } from '@app/network/types' 2 | import { Subscription } from 'rxjs' 3 | import { WebSocketSubject } from 'rxjs/webSocket' 4 | 5 | export let signalWebsocket: WebSocketSubject 6 | let websocketSub: Subscription 7 | 8 | export function setSignalWebsocket(sws: WebSocketSubject): void { 9 | signalWebsocket = sws 10 | } 11 | 12 | export function setWebsocketSubscription(sub: Subscription): void { 13 | websocketSub = sub 14 | } 15 | export function subscribeWebsocket(username: string): void { 16 | const wsm: SubscribeWebSocketMessage = { 17 | action: 'subscribe', 18 | channels: [username], 19 | } 20 | signalWebsocket.next(wsm) 21 | } 22 | 23 | export function closeWebsocket(): void { 24 | websocketSub.unsubscribe() 25 | } 26 | -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/ui/session-list.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | 3 | import { useObservable } from '@app/hooks' 4 | import SessionSummary from './session-summary' 5 | import AddSession from './add-session' 6 | import { sessionListSubject } from '../state' 7 | import { usernameSubject } from '@app/identity/state' 8 | 9 | export default function SessionList(): JSX.Element { 10 | const sessionList = useObservable(sessionListSubject, []) 11 | const username = useObservable(usernameSubject, '') 12 | 13 | return ( 14 |
15 |

Chat Sessions ({username})

16 | 17 |
    18 | {sessionList.map((session) => ( 19 | 20 | ))} 21 |
22 | 23 |
24 | ) 25 | } 26 | -------------------------------------------------------------------------------- /signal-protocol-client/src/messages/ui/compose-message.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState } from 'react' 2 | 3 | import { encryptAndSendMessage } from '../functions' 4 | 5 | export interface ComposeMessageProps { 6 | toUser: string 7 | } 8 | 9 | export default function ComposeMessage(props: ComposeMessageProps): JSX.Element { 10 | const [message, setMessage] = useState('') 11 | 12 | const sendMessage = async (to: string, message: string) => { 13 | encryptAndSendMessage(to, message) 14 | setMessage('') 15 | } 16 | 17 | return ( 18 |
19 | { 23 | setMessage(event.target.value) 24 | }} 25 | /> 26 | 27 |
28 | ) 29 | } 30 | -------------------------------------------------------------------------------- /simple/README.md: -------------------------------------------------------------------------------- 1 | # Demo React Application using the libsignal-protocol-typescript 2 | 3 | This simple web application demonstrates basic usage of the [Signal Typescript SDK](https://github.com/privacyresearchgroup/libsignal-protocol-typescript). 4 | The application has two agents who register with a directory service, create a Signal Protocol session, and send encrypted messages. The application describes these steps, with reference to the source code, as you use it. The source code itself is a starting point for your own Signal Protocol application. 5 | 6 | For an example of what server components are needed to support Signal Protocol messaging, look at this [serverless backend](https://github.com/privacyresearchgroup/signal-demo-backend). 7 | 8 | Play with it online [here](https://signal-demo.privacyresearch.io/). 9 | 10 | ## License 11 | 12 | 13 | This project is licensed under [GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html). 14 | 15 | Copyright 2022 - Privacy Research, LLC -------------------------------------------------------------------------------- /signal-protocol-client/src/App.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import './App.css' 3 | import CreateIdentity from './identity/ui/create-identity' 4 | import SessionList from './sessions/ui/session-list' 5 | import SessionDetails from './sessions/ui/session-details' 6 | import { useObservable } from './hooks' 7 | import { usernameSubject } from './identity/state' 8 | import { currentSessionSubject } from './sessions/state' 9 | 10 | function App() { 11 | const username = useObservable(usernameSubject, '') 12 | const currSession = useObservable(currentSessionSubject, null) 13 | return ( 14 |

Signal Protocol Chat

15 |

16 | A demonstration of the Signal Protocol Typescript SDK. 17 | Source code available here. 18 | 19 |

20 |
21 | { 22 | username ? currSession ? : : } 23 |
24 | ) 25 | } 26 | 27 | export default App 28 | -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/ui/add-session.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState } from 'react' 2 | import { currentSessionSubject, sessionForRemoteUser } from '@app/sessions/state' 3 | import { startSession } from '@app/sessions/functions' 4 | 5 | export default function AddSession(): JSX.Element { 6 | const [remoteUsername, setRemoteUsername] = useState('') 7 | 8 | const createSession = () => { 9 | startSession(remoteUsername) 10 | currentSessionSubject.next(sessionForRemoteUser(remoteUsername) || null) 11 | setRemoteUsername('') 12 | } 13 | 14 | return ( 15 |
16 |

Create a new chat session

17 |

Look up a user by username and start and end-to-end-encrypted chat

18 | { 22 | setRemoteUsername(event.target.value) 23 | }} 24 | > 25 | 28 |
29 | ) 30 | } 31 | -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/ui/session-summary.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import ReactTimeAgo from 'react-time-ago' 3 | 4 | import TimeAgo from 'javascript-time-ago' 5 | 6 | import en from 'javascript-time-ago/locale/en.json' 7 | import { currentSessionSubject, sessionForRemoteUser } from '../state' 8 | import { ChatSession } from '../types' 9 | 10 | console.log('add locale', { en }) 11 | TimeAgo.addLocale(en) 12 | 13 | export interface SessionSummaryProps { 14 | session: ChatSession 15 | } 16 | 17 | export default function SessionSummary(props: SessionSummaryProps): JSX.Element { 18 | const { session } = props 19 | const { messages, remoteUsername } = session 20 | const lastActivity = (messages.length && Math.max(...messages.map((m) => m.timestamp))) || Date.now() 21 | 22 | console.log({ lastActivity }) 23 | 24 | const viewChatSession = (username: string) => { 25 | currentSessionSubject.next(sessionForRemoteUser(username || '') || null) 26 | } 27 | 28 | return ( 29 |
  • 30 | {' '} 31 | {remoteUsername} {' '} 32 | 33 |
    • 34 | ) 35 | } 36 | -------------------------------------------------------------------------------- /simple/src/signal-directory.ts: -------------------------------------------------------------------------------- 1 | import { SignedPublicPreKeyType, DeviceType, PreKeyType } from "@privacyresearch/libsignal-protocol-typescript"; 2 | 3 | 4 | export interface PublicDirectoryEntry { 5 | identityPubKey: ArrayBuffer 6 | signedPreKey: SignedPublicPreKeyType 7 | oneTimePreKey?: ArrayBuffer 8 | } 9 | 10 | interface FullDirectoryEntry { 11 | registrationId: number 12 | identityPubKey: ArrayBuffer 13 | signedPreKey: SignedPublicPreKeyType 14 | oneTimePreKeys: PreKeyType[] 15 | } 16 | 17 | export class SignalDirectory{ 18 | private _data: {[address: string]: FullDirectoryEntry} = {} 19 | 20 | storeKeyBundle(address: string, bundle: FullDirectoryEntry) : void { 21 | this._data[address] = bundle 22 | } 23 | 24 | addOneTimePreKeys(address: string, keys: PreKeyType[]): void { 25 | this._data[address].oneTimePreKeys.unshift(...keys) 26 | } 27 | 28 | getPreKeyBundle(address: string): DeviceType | undefined { 29 | const bundle = this._data[address] 30 | if(!bundle) { 31 | return undefined 32 | } 33 | const oneTimePreKey = bundle.oneTimePreKeys.pop() 34 | const { identityPubKey, signedPreKey, registrationId } = bundle 35 | return { identityKey: identityPubKey, signedPreKey, preKey: oneTimePreKey, registrationId } 36 | } 37 | } -------------------------------------------------------------------------------- /simple/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "libsignal-typescript-demo", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "@craco/craco": "^6.4.3", 7 | "@material-ui/core": "^4.12.3", 8 | "@material-ui/icons": "^4.11.2", 9 | "@privacyresearch/libsignal-protocol-typescript": "^0.0.15", 10 | "highlight.js": "^11.4.0", 11 | "react": "^17.0.2", 12 | "react-dom": "^17.0.2", 13 | "react-markdown": "^8.0.0", 14 | "react-scripts": "5.0.0", 15 | "react-syntax-highlighter": "^15.4.5", 16 | "typescript": "~4.5.5" 17 | }, 18 | "scripts": { 19 | "start": "craco start", 20 | "build": "craco build", 21 | "test": "craco test", 22 | "eject": "react-scripts eject", 23 | "format": "prettier '**/{*.{js?(on),ts?(x),md},.*.js?(on)}' --write --list-different --config prettier.config.js" 24 | }, 25 | "eslintConfig": { 26 | "extends": "react-app" 27 | }, 28 | "browserslist": { 29 | "production": [ 30 | ">0.2%", 31 | "not dead", 32 | "not op_mini all" 33 | ], 34 | "development": [ 35 | "last 1 chrome version", 36 | "last 1 firefox version", 37 | "last 1 safari version" 38 | ] 39 | }, 40 | "devDependencies": { 41 | "@testing-library/jest-dom": "^5.16.1", 42 | "@testing-library/react": "^12.1.2", 43 | "@testing-library/user-event": "^13.5.0", 44 | "@types/jest": "^27.4.0", 45 | "@types/node": "^17.0.14", 46 | "@types/react": "^17.0.38", 47 | "@types/react-dom": "^17.0.11", 48 | "prettier": "^2.5.1" 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/ui/session-details.tsx: -------------------------------------------------------------------------------- 1 | import { useObservable } from '@app/hooks' 2 | import React from 'react' 3 | 4 | import ComposeMessage from '@app/messages/ui/compose-message' 5 | import MessageList from '@app/messages/ui/message-list' 6 | import { currentSessionSubject } from '../state' 7 | import { usernameSubject } from '@app/identity/state' 8 | 9 | export default function SessionDetails(): JSX.Element { 10 | const session = useObservable(currentSessionSubject, null) 11 | const username = useObservable(usernameSubject, '') 12 | 13 | console.log({ session }) 14 | 15 | const clearCurrentSession = () => { 16 | currentSessionSubject.next(null) 17 | } 18 | 19 | return ( 20 | (session && ( 21 |
    22 |

    23 | Chat: {username} - {session.remoteUsername} 24 |

    25 | 28 | 29 |
    30 | 31 |
    32 |
    33 | )) || ( 34 |
    35 |

    No active session

    36 | 39 |
    40 | ) 41 | ) 42 | } 43 | -------------------------------------------------------------------------------- /signal-protocol-client/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "signal-protocol-client", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "@craco/craco": "^6.4.3", 7 | "@material-ui/core": "^4.12.3", 8 | "@privacyresearch/libsignal-protocol-typescript": "^0.0.15", 9 | "@testing-library/jest-dom": "^5.16.1", 10 | "@testing-library/react": "^12.1.2", 11 | "@testing-library/user-event": "^13.5.0", 12 | "@types/jest": "^27.4.0", 13 | "@types/node": "^17.0.14", 14 | "@types/react": "^17.0.38", 15 | "@types/react-dom": "^17.0.11", 16 | "base64-js": "^1.5.1", 17 | "javascript-time-ago": "^2.3.11", 18 | "react": "^17.0.2", 19 | "react-dom": "^17.0.2", 20 | "react-scripts": "5.0.0", 21 | "react-time-ago": "^7.1.9", 22 | "rxjs": "^7.5.2", 23 | "typescript": "^4.5.5", 24 | "uuid": "^8.3.2", 25 | "web-vitals": "^2.1.4" 26 | }, 27 | "scripts": { 28 | "start": "craco start", 29 | "build": "craco build", 30 | "test": "craco test", 31 | "eject": "react-scripts eject", 32 | "format": "prettier '**/{*.{js?(on),ts?(x),md},.*.js?(on)}' --write --list-different --config prettier.config.js" 33 | }, 34 | "eslintConfig": { 35 | "extends": [ 36 | "react-app", 37 | "react-app/jest" 38 | ] 39 | }, 40 | "browserslist": { 41 | "production": [ 42 | ">0.2%", 43 | "not dead", 44 | "not op_mini all" 45 | ], 46 | "development": [ 47 | "last 1 chrome version", 48 | "last 1 firefox version", 49 | "last 1 safari version" 50 | ] 51 | }, 52 | "devDependencies": { 53 | "@types/uuid": "^8.3.4", 54 | "prettier": "^2.5.1" 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /signal-protocol-client/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 12 | 13 | 17 | 18 | 27 | React App 28 | 29 | 30 | 31 |
    32 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /simple/public/createid.md: -------------------------------------------------------------------------------- 1 | Here's what happens. 2 | 3 | First, we use `KeyHelper` to generate a registration ID and store it 4 | 5 | ```ts 6 | const registrationId = KeyHelper.generateRegistrationId(); 7 | // Store registrationId somewhere durable and safe... Or do this. 8 | storeSomewhereSafe(store)(`registrationID`, registrationId); 9 | ``` 10 | 11 | Then when use `KeyHelper` to generate an identity key pair. In a real appliocation, 12 | the private key in this pair must be stored safely. 13 | 14 | ```ts 15 | const identityKeyPair = await KeyHelper.generateIdentityKeyPair(); 16 | // Store identityKeyPair somewhere durable and safe... Or do this. 17 | storeSomewhereSafe(store)("identityKey", identityKeyPair); 18 | ``` 19 | 20 | Now we generate a one-time use prekey and a signed pre-key, storing both locally 21 | 22 | ```ts 23 | const baseKeyId = Math.floor(10000 * Math.random()); 24 | const preKey = await KeyHelper.generatePreKey(baseKeyId); 25 | store.storePreKey(`${baseKeyId}`, preKey.keyPair); 26 | 27 | const signedPreKeyId = Math.floor(10000 * Math.random()); 28 | const signedPreKey = await KeyHelper.generateSignedPreKey( 29 | identityKeyPair, 30 | signedPreKeyId 31 | ); 32 | store.storeSignedPreKey(signedPreKeyId, signedPreKey.keyPair); 33 | ``` 34 | 35 | Finally we store the associated public keys and signatures in a directory so other users can find them. 36 | 37 | ```ts 38 | const publicSignedPreKey: SignedPublicPreKeyType = { 39 | keyId: signedPreKeyId, 40 | publicKey: signedPreKey.keyPair.pubKey, 41 | signature: signedPreKey.signature, 42 | }; 43 | 44 | // Now we register this with the server so all users can see them 45 | const publicPreKey: PreKeyType = { 46 | keyId: preKey.keyId, 47 | publicKey: preKey.keyPair.pubKey, 48 | }; 49 | directory.storeKeyBundle(name, { 50 | registrationId, 51 | identityPubKey: identityKeyPair.pubKey, 52 | signedPreKey: publicSignedPreKey, 53 | oneTimePreKeys: [publicPreKey], 54 | }); 55 | ``` 56 | -------------------------------------------------------------------------------- /simple/public/start-session-with-b.md: -------------------------------------------------------------------------------- 1 | ## Starting a session and sending a first message 2 | 3 | The first thing we do is look up Brünhild in the directory and get a prekey bundle. 4 | 5 | ```typescript 6 | // get Brünhild's key bundle 7 | const brunhildeBundle = directory.getPreKeyBundle("brünhild"); 8 | ``` 9 | 10 | Then we build a Signal session for this recipient in our local store. 11 | 12 | ```typescript 13 | const recipientAddress = new SignalProtocolAddress("brünhild", 1); 14 | 15 | // Instantiate a SessionBuilder for a remote recipientId + deviceId tuple. 16 | const sessionBuilder = new SessionBuilder(adalheidStore, recipientAddress); 17 | ``` 18 | 19 | Now we can use this session to process the prekey bundle for this session. 20 | 21 | ```typescript 22 | // Process a prekey fetched from the server. Returns a promise that resolves 23 | // once a session is created and saved in the store, or rejects if the 24 | // identityKey differs from a previously seen identity for this address. 25 | await sessionBuilder.processPreKey(brunhildeBundle!); 26 | ``` 27 | 28 | With the session built, we are ready to create a `SessionCipher` and encrypt a message. We'll just 29 | send a fixed first message, `starterMessage`, here but it could be any message you like. 30 | Since it is the first message in the session, it will be a `PreKeyWhisperMessage`. 31 | 32 | ```typescript 33 | const starterMessageBytes = Uint8Array.from([ 34 | 0xce, 35 | 0x93, 36 | 0xce, 37 | 0xb5, 38 | 0xce, 39 | 0xb9, 40 | 0xce, 41 | 0xac, 42 | 0x20, 43 | 0xcf, 44 | 0x83, 45 | 0xce, 46 | 0xbf, 47 | 0xcf, 48 | 0x85, 49 | ]); 50 | 51 | // Now we can send an encrypted message 52 | const adalheidSessionCipher = new SessionCipher( 53 | adalheidStore, 54 | recipientAddress 55 | ); 56 | const ciphertext = await adalheidSessionCipher.encrypt( 57 | starterMessageBytes.buffer 58 | ); 59 | ``` 60 | 61 | Finaly we send it over whatever channel we like. 62 | 63 | ```typescript 64 | sendMessage("brünhild", "adalheid", ciphertext); 65 | ``` 66 | -------------------------------------------------------------------------------- /simple/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 10 | 11 | 12 | 16 | 17 | 21 | 22 | 31 | React App 32 | 33 | 34 | 35 |
    36 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /simple/public/start-session-with-a.md: -------------------------------------------------------------------------------- 1 | ## Starting a session and sending a first message 2 | 3 | The first thing we do is look up Adalheid in the directory and get a prekey bundle. 4 | 5 | ```typescript 6 | // get Adalheid's key bundle 7 | const adalheidBundle = directory.getPreKeyBundle("adalheid"); 8 | ``` 9 | 10 | Then we build a Signal session for this recipient in our local store. 11 | 12 | ```typescript 13 | const recipientAddress = new SignalProtocolAddress("adalheid", 1); 14 | 15 | // Instantiate a SessionBuilder for a remote recipientId + deviceId tuple. 16 | const sessionBuilder = new SessionBuilder(brunhildeStore, recipientAddress); 17 | ``` 18 | 19 | Now we can use this session to process the prekey bundle for this session. 20 | 21 | ```typescript 22 | // Process a prekey fetched from the server. Returns a promise that resolves 23 | // once a session is created and saved in the store, or rejects if the 24 | // identityKey differs from a previously seen identity for this address. 25 | console.log("brünhild processing prekey"); 26 | await sessionBuilder.processPreKey(adalheidBundle!); 27 | ``` 28 | 29 | With the session built, we are ready to create a `SessionCipher` and encrypt a message. We'll just 30 | send a fixed first message, `starterMessage`, here but it could be any message you like. 31 | Since it is the first message in the session, it will be a `PreKeyWhisperMessage`. 32 | 33 | ```typescript 34 | const starterMessageBytes = Uint8Array.from([ 35 | 0xce, 36 | 0x93, 37 | 0xce, 38 | 0xb5, 39 | 0xce, 40 | 0xb9, 41 | 0xce, 42 | 0xac, 43 | 0x20, 44 | 0xcf, 45 | 0x83, 46 | 0xce, 47 | 0xbf, 48 | 0xcf, 49 | 0x85, 50 | ]); 51 | 52 | // Now we can send an encrypted message 53 | const brunhildeSessionCipher = new SessionCipher( 54 | brunhildeStore, 55 | recipientAddress 56 | ); 57 | const ciphertext = await brunhildeSessionCipher.encrypt( 58 | starterMessageBytes.buffer 59 | ); 60 | ``` 61 | 62 | Finaly we send it over whatever channel we like. 63 | 64 | ```typescript 65 | sendMessage("adalheid", "brünhild", ciphertext); 66 | ``` 67 | -------------------------------------------------------------------------------- /signal-protocol-client/src/messages/api.ts: -------------------------------------------------------------------------------- 1 | import { MessageType } from '@privacyresearch/libsignal-protocol-typescript' 2 | import { Subscription } from 'rxjs' 3 | import { webSocket } from 'rxjs/webSocket' 4 | import { setSignalWebsocket, setWebsocketSubscription, signalWebsocket } from '@app/network/websocket' 5 | 6 | import { processPreKeyMessage, processRegularMessage } from '@app/messages/functions' 7 | import { isSendWebSocketMessage, SendWebSocketMessage, WebSocketMessage } from '@app/network/types' 8 | 9 | export function sendSignalProtocolMessage(to: string, from: string, message: MessageType): void { 10 | const wsm: SendWebSocketMessage = { 11 | action: 'sendMessage', 12 | address: to, 13 | from, 14 | message: JSON.stringify(message), 15 | } 16 | console.log('sending message to websocket', {wsm}) 17 | signalWebsocket.next(wsm) 18 | } 19 | 20 | export function initializeSignalWebsocket(uri: string): Subscription { 21 | console.log('initializing websocket', {uri}) 22 | setSignalWebsocket(webSocket(uri)) 23 | 24 | const sub = signalWebsocket.subscribe({ 25 | next: (msg) => { 26 | console.log(`received message on signal wss`) 27 | if (isSendWebSocketMessage(msg)) { 28 | processWebsocketMessage(msg).catch((e) => { 29 | console.warn(`error accepting signal message`, { e }) 30 | }) 31 | } else { 32 | console.error('Message on wss is not recognized', {msg}) 33 | } 34 | }, 35 | error: (err) => { 36 | console.error(err) 37 | }, 38 | complete: () => { 39 | console.log(`signal websocket complete`) 40 | }, 41 | }) 42 | 43 | setWebsocketSubscription(sub) 44 | return sub 45 | } 46 | 47 | export async function processWebsocketMessage(wsm: SendWebSocketMessage): Promise { 48 | const signalMessage = JSON.parse(wsm.message) as MessageType 49 | console.log(`processing signal message`, {signalMessage}) 50 | if (signalMessage.type === 1) { 51 | await processRegularMessage(wsm.from, signalMessage) 52 | } else if (signalMessage.type === 3) { 53 | await processPreKeyMessage(wsm.from, signalMessage) 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /signal-protocol-client/src/identity/functions.ts: -------------------------------------------------------------------------------- 1 | import { initializeSignalWebsocket } from '@app/messages/api' 2 | import { networkInfoSubject } from '@app/network/state' 3 | import { subscribeWebsocket } from '@app/network/websocket' 4 | import { KeyHelper, PreKeyType, SignedPublicPreKeyType } from '@privacyresearch/libsignal-protocol-typescript' 5 | import { SignalDirectory } from '../signal/signal-directory' 6 | import { directorySubject, signalStore, usernameSubject } from './state' 7 | 8 | export async function createIdentity(username: string, url: string, wss: string, apiKey: string): Promise { 9 | const directory = new SignalDirectory(url, apiKey) 10 | directorySubject.next(directory) 11 | usernameSubject.next(username) 12 | networkInfoSubject.next({ apiURL: url, apiKey, wssURI: wss }) 13 | 14 | initializeSignalWebsocket(wss) 15 | subscribeWebsocket(username) 16 | 17 | const registrationId = KeyHelper.generateRegistrationId() 18 | // Store registrationId somewhere durable and safe... Or do this. 19 | signalStore.put(`registrationID`, registrationId) 20 | 21 | const identityKeyPair = await KeyHelper.generateIdentityKeyPair() 22 | // Store identityKeyPair somewhere durable and safe... Or do this. 23 | signalStore.put('identityKey', identityKeyPair) 24 | console.log('Generated identity key', { identityKeyPair }) 25 | 26 | const baseKeyId = Math.floor(10000 * Math.random()) 27 | const preKey = await KeyHelper.generatePreKey(baseKeyId) 28 | signalStore.storePreKey(`${baseKeyId}`, preKey.keyPair) 29 | console.log('Generated pre key', { preKey }) 30 | 31 | const signedPreKeyId = Math.floor(10000 * Math.random()) 32 | const signedPreKey = await KeyHelper.generateSignedPreKey(identityKeyPair, signedPreKeyId) 33 | signalStore.storeSignedPreKey(signedPreKeyId, signedPreKey.keyPair) 34 | const publicSignedPreKey: SignedPublicPreKeyType = { 35 | keyId: signedPreKeyId, 36 | publicKey: signedPreKey.keyPair.pubKey, 37 | signature: signedPreKey.signature, 38 | } 39 | 40 | // Now we register this with the server so all users can see them 41 | const publicPreKey: PreKeyType = { 42 | keyId: preKey.keyId, 43 | publicKey: preKey.keyPair.pubKey, 44 | } 45 | directory.storeKeyBundle(username, { 46 | registrationId, 47 | identityKey: identityKeyPair.pubKey, 48 | signedPreKey: publicSignedPreKey, 49 | oneTimePreKeys: [publicPreKey], 50 | }) 51 | } 52 | -------------------------------------------------------------------------------- /signal-protocol-client/src/sessions/functions.ts: -------------------------------------------------------------------------------- 1 | import { directorySubject, signalStore, usernameSubject } from '@app/identity/state' 2 | import { sendSignalProtocolMessage } from '@app/messages/api' 3 | import { ProcessedChatMessage } from '@app/messages/types' 4 | import { SessionBuilder, SessionCipher, SignalProtocolAddress } from '@privacyresearch/libsignal-protocol-typescript' 5 | import { currentSessionSubject, sessionForRemoteUser, sessionListSubject } from './state' 6 | import { ChatSession } from '@app/sessions/types' 7 | 8 | export async function startSession(recipient: string): Promise { 9 | const directory = directorySubject.value! 10 | const keyBundle = await directory.getPreKeyBundle(recipient) 11 | 12 | const recipientAddress = new SignalProtocolAddress(recipient, 1) 13 | 14 | // Instantiate a SessionBuilder for a remote recipientId + deviceId tuple. 15 | const sessionBuilder = new SessionBuilder(signalStore, recipientAddress) 16 | 17 | // Process a prekey fetched from the server. Returns a promise that resolves 18 | // once a session is created and saved in the store, or rejects if the 19 | // identityKey differs from a previously seen identity for this address. 20 | const session = await sessionBuilder.processPreKey(keyBundle!) 21 | console.log({ session, keyBundle }) 22 | 23 | // Now we can send an encrypted message 24 | const sessionCipher = new SessionCipher(signalStore, recipientAddress) 25 | const ciphertext = await sessionCipher.encrypt(Uint8Array.from([0, 0, 0, 0]).buffer) 26 | 27 | sendSignalProtocolMessage(recipient, usernameSubject.value, ciphertext) 28 | 29 | const newSession: ChatSession = { 30 | remoteUsername: recipient, 31 | messages: [], 32 | } 33 | console.log(`Starting session with ${recipient}`, {ciphertext}) 34 | const sessionList = [...sessionListSubject.value] 35 | sessionList.unshift(newSession) 36 | sessionListSubject.next(sessionList) 37 | } 38 | 39 | export function addMessageToSession(address: string, cm: ProcessedChatMessage): void { 40 | const userSession = { ...sessionForRemoteUser(address)! } 41 | 42 | userSession.messages.push(cm) 43 | const sessionList = sessionListSubject.value.filter((session) => session.remoteUsername !== address) 44 | console.log('Filtered session list', { sessionList }) 45 | sessionList.unshift(userSession) 46 | sessionListSubject.next(sessionList) 47 | if (currentSessionSubject.value?.remoteUsername === address) { 48 | currentSessionSubject.next(userSession) 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /signal-protocol-client/src/logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /simple/src/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /signal-protocol-client/src/messages/functions.ts: -------------------------------------------------------------------------------- 1 | import { v4 as uuid } from 'uuid' 2 | 3 | import { signalStore, usernameSubject } from '@app/identity/state' 4 | import { addMessageToSession } from '@app/sessions/functions' 5 | import { sessionForRemoteUser, sessionListSubject } from '@app/sessions/state' 6 | import { ChatSession } from '@app/sessions/types' 7 | import { MessageType, SessionCipher, SignalProtocolAddress } from '@privacyresearch/libsignal-protocol-typescript' 8 | import { sendSignalProtocolMessage } from './api' 9 | import { ProcessedChatMessage } from './types' 10 | 11 | export async function processPreKeyMessage(address: string, message: MessageType): Promise { 12 | console.log('processPreKeyMessage') 13 | const cipher = new SessionCipher(signalStore, new SignalProtocolAddress(address, 1)) 14 | const plaintextBytes = await cipher.decryptPreKeyWhisperMessage(message.body!, 'binary') 15 | 16 | const session : ChatSession= sessionForRemoteUser(address) || { 17 | remoteUsername: address, 18 | messages: [], 19 | } 20 | 21 | 22 | const sessionList = [...sessionListSubject.value] 23 | sessionList.unshift(session) 24 | sessionListSubject.next(sessionList) 25 | 26 | 27 | let cm: ProcessedChatMessage | null = null 28 | try{ 29 | const plaintext = new TextDecoder().decode(new Uint8Array(plaintextBytes)) 30 | cm = JSON.parse(plaintext) as ProcessedChatMessage 31 | 32 | addMessageToSession(address, cm) 33 | } catch (e) { 34 | console.log('PreKey message does not contain JSON') 35 | } 36 | } 37 | 38 | export async function processRegularMessage(address: string, message: MessageType): Promise { 39 | console.log('processRegularMessage') 40 | const cipher = new SessionCipher(signalStore, new SignalProtocolAddress(address, 1)) 41 | const plaintextBytes = await cipher.decryptWhisperMessage(message.body!, 'binary') 42 | const plaintext = new TextDecoder().decode(new Uint8Array(plaintextBytes)) 43 | 44 | const cm: ProcessedChatMessage = JSON.parse(plaintext) 45 | console.log('Decrypted: ', { cm }) 46 | addMessageToSession(address, cm) 47 | } 48 | 49 | export async function encryptAndSendMessage(to: string, message: string): Promise { 50 | const address = new SignalProtocolAddress(to, 1) 51 | const cipher = new SessionCipher(signalStore, address) 52 | 53 | const cm: ProcessedChatMessage = { 54 | id: uuid(), 55 | address: to, 56 | from: usernameSubject.value, 57 | timestamp: Date.now(), 58 | body: message, 59 | } 60 | addMessageToSession(to, cm) 61 | const signalMessage = await cipher.encrypt(new TextEncoder().encode(JSON.stringify(cm)).buffer) 62 | sendSignalProtocolMessage(to, usernameSubject.value, signalMessage) 63 | } 64 | -------------------------------------------------------------------------------- /signal-protocol-client/src/identity/ui/create-identity.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState } from 'react' 2 | 3 | import { createIdentity } from '../functions' 4 | 5 | export default function CreateIdentity(): JSX.Element { 6 | const [username, setUsername] = useState('') 7 | const [url, setUrl] = useState('https://x94jzhh4el.execute-api.us-west-2.amazonaws.com/temp') 8 | const [wss, setWss] = useState('wss://56f7nk7zkg.execute-api.us-west-2.amazonaws.com/temp') 9 | const [apiKey, setApiKey] = useState('') 10 | 11 | const createID = async () => { 12 | await createIdentity(username, url, wss, apiKey) 13 | } 14 | 15 | return ( 16 |
    17 |
    18 | 21 | { 27 | setUsername(event.target.value) 28 | }} 29 | /> 30 |
    31 |
    32 | 35 | { 41 | setUrl(event.target.value) 42 | }} 43 | /> 44 |
    45 |
    46 | 49 | { 55 | setWss(event.target.value) 56 | }} 57 | /> 58 |
    59 |
    60 | 63 | { 69 | setApiKey(event.target.value) 70 | }} 71 | /> 72 |
    73 |
    74 | 77 |
    78 |
    79 | ) 80 | } 81 | -------------------------------------------------------------------------------- /signal-protocol-client/src/signal/signal-directory.ts: -------------------------------------------------------------------------------- 1 | import { SignedPublicPreKeyType, DeviceType, PreKeyType } from '@privacyresearch/libsignal-protocol-typescript' 2 | import * as base64 from 'base64-js' 3 | 4 | export interface PublicDirectoryEntry { 5 | identityKey: ArrayBuffer 6 | signedPreKey: SignedPublicPreKeyType 7 | oneTimePreKey?: ArrayBuffer 8 | } 9 | 10 | interface FullDirectoryEntry { 11 | registrationId: number 12 | identityKey: ArrayBuffer 13 | signedPreKey: SignedPublicPreKeyType 14 | oneTimePreKeys: PreKeyType[] 15 | } 16 | 17 | export interface PublicPreKey { 18 | keyId: number 19 | publicKey: string 20 | } 21 | 22 | export interface SignedPublicKey { 23 | keyId: number 24 | publicKey: string 25 | signature: string 26 | } 27 | 28 | export interface PublicPreKeyBundle { 29 | identityKey: string 30 | signedPreKey: SignedPublicKey 31 | preKey?: PublicPreKey 32 | registrationId: number 33 | } 34 | 35 | interface SerializedFullDirectoryEntry { 36 | registrationId: number 37 | identityKey: string 38 | signedPreKey: SignedPublicKey 39 | oneTimePreKeys: PublicPreKey[] 40 | } 41 | 42 | export class SignalDirectory { 43 | constructor(private _url: string, private _apiKey: string) {} 44 | 45 | async storeKeyBundle(address: string, bundle: FullDirectoryEntry): Promise { 46 | const res = await fetch(`${this._url}/keys/${address}`, { 47 | method: 'PUT', 48 | headers: { 'x-api-key': this._apiKey }, 49 | body: JSON.stringify(serializeKeyRegistrationBundle(bundle)), 50 | }) 51 | await res.json() 52 | } 53 | 54 | async getPreKeyBundle(address: string): Promise { 55 | const res = await fetch(`${this._url}/keys/${address}`, { headers: { 'x-api-key': this._apiKey } }) 56 | const bundle = await res.json() 57 | if (!bundle) { 58 | return undefined 59 | } 60 | const { identityKey, signedPreKey, registrationId, preKey } = bundle 61 | return deserializeKeyBundle({ identityKey, signedPreKey, preKey, registrationId }) 62 | } 63 | 64 | get url(): string { 65 | return this._url 66 | } 67 | 68 | get apiKey(): string { 69 | return this._apiKey 70 | } 71 | } 72 | 73 | export function serializeKeyRegistrationBundle(dv: FullDirectoryEntry): SerializedFullDirectoryEntry { 74 | const identityKey = base64.fromByteArray(new Uint8Array(dv.identityKey)) 75 | const signedPreKey: SignedPublicKey = { 76 | keyId: dv.signedPreKey.keyId, 77 | publicKey: base64.fromByteArray(new Uint8Array(dv.signedPreKey.publicKey)), 78 | signature: base64.fromByteArray(new Uint8Array(dv.signedPreKey.signature)), 79 | } 80 | 81 | const oneTimePreKeys: PublicPreKey[] = dv.oneTimePreKeys.map((pk) => ({ 82 | keyId: pk.keyId, 83 | publicKey: base64.fromByteArray(new Uint8Array(pk.publicKey)), 84 | })) 85 | 86 | return { 87 | identityKey, 88 | signedPreKey, 89 | oneTimePreKeys, 90 | registrationId: dv.registrationId!, 91 | } 92 | } 93 | 94 | export function serializeKeyBundle(dv: DeviceType): PublicPreKeyBundle { 95 | const identityKey = base64.fromByteArray(new Uint8Array(dv.identityKey)) 96 | const signedPreKey: SignedPublicKey = { 97 | keyId: dv.signedPreKey.keyId, 98 | publicKey: base64.fromByteArray(new Uint8Array(dv.signedPreKey.publicKey)), 99 | signature: base64.fromByteArray(new Uint8Array(dv.signedPreKey.signature)), 100 | } 101 | 102 | const preKey: PublicPreKey = { 103 | keyId: dv.preKey!.keyId, 104 | publicKey: base64.fromByteArray(new Uint8Array(dv.preKey!.publicKey)), 105 | } 106 | 107 | return { 108 | identityKey, 109 | signedPreKey, 110 | preKey, 111 | registrationId: dv.registrationId!, 112 | } 113 | } 114 | 115 | export function deserializeKeyBundle(kb: PublicPreKeyBundle): DeviceType { 116 | const identityKey = base64.toByteArray(kb.identityKey).buffer 117 | const signedPreKey: SignedPublicPreKeyType = { 118 | keyId: kb.signedPreKey.keyId, 119 | publicKey: base64.toByteArray(kb.signedPreKey.publicKey), 120 | signature: base64.toByteArray(kb.signedPreKey.signature), 121 | } 122 | const preKey: PreKeyType | undefined = kb.preKey && { 123 | keyId: kb.preKey.keyId, 124 | publicKey: base64.toByteArray(kb.preKey.publicKey), 125 | } 126 | 127 | return { 128 | identityKey, 129 | signedPreKey, 130 | preKey, 131 | registrationId: kb.registrationId, 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /simple/src/serviceWorker.ts: -------------------------------------------------------------------------------- 1 | // This optional code is used to register a service worker. 2 | // register() is not called by default. 3 | 4 | // This lets the app load faster on subsequent visits in production, and gives 5 | // it offline capabilities. However, it also means that developers (and users) 6 | // will only see deployed updates on subsequent visits to a page, after all the 7 | // existing tabs open on the page have been closed, since previously cached 8 | // resources are updated in the background. 9 | 10 | // To learn more about the benefits of this model and instructions on how to 11 | // opt-in, read https://bit.ly/CRA-PWA 12 | 13 | const isLocalhost = Boolean( 14 | window.location.hostname === 'localhost' || 15 | // [::1] is the IPv6 localhost address. 16 | window.location.hostname === '[::1]' || 17 | // 127.0.0.0/8 are considered localhost for IPv4. 18 | window.location.hostname.match( 19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 20 | ) 21 | ); 22 | 23 | type Config = { 24 | onSuccess?: (registration: ServiceWorkerRegistration) => void; 25 | onUpdate?: (registration: ServiceWorkerRegistration) => void; 26 | }; 27 | 28 | export function register(config?: Config) { 29 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 30 | // The URL constructor is available in all browsers that support SW. 31 | const publicUrl = new URL( 32 | process.env.PUBLIC_URL, 33 | window.location.href 34 | ); 35 | if (publicUrl.origin !== window.location.origin) { 36 | // Our service worker won't work if PUBLIC_URL is on a different origin 37 | // from what our page is served on. This might happen if a CDN is used to 38 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374 39 | return; 40 | } 41 | 42 | window.addEventListener('load', () => { 43 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 44 | 45 | if (isLocalhost) { 46 | // This is running on localhost. Let's check if a service worker still exists or not. 47 | checkValidServiceWorker(swUrl, config); 48 | 49 | // Add some additional logging to localhost, pointing developers to the 50 | // service worker/PWA documentation. 51 | navigator.serviceWorker.ready.then(() => { 52 | console.log( 53 | 'This web app is being served cache-first by a service ' + 54 | 'worker. To learn more, visit https://bit.ly/CRA-PWA' 55 | ); 56 | }); 57 | } else { 58 | // Is not localhost. Just register service worker 59 | registerValidSW(swUrl, config); 60 | } 61 | }); 62 | } 63 | } 64 | 65 | function registerValidSW(swUrl: string, config?: Config) { 66 | navigator.serviceWorker 67 | .register(swUrl) 68 | .then(registration => { 69 | registration.onupdatefound = () => { 70 | const installingWorker = registration.installing; 71 | if (installingWorker == null) { 72 | return; 73 | } 74 | installingWorker.onstatechange = () => { 75 | if (installingWorker.state === 'installed') { 76 | if (navigator.serviceWorker.controller) { 77 | // At this point, the updated precached content has been fetched, 78 | // but the previous service worker will still serve the older 79 | // content until all client tabs are closed. 80 | console.log( 81 | 'New content is available and will be used when all ' + 82 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.' 83 | ); 84 | 85 | // Execute callback 86 | if (config && config.onUpdate) { 87 | config.onUpdate(registration); 88 | } 89 | } else { 90 | // At this point, everything has been precached. 91 | // It's the perfect time to display a 92 | // "Content is cached for offline use." message. 93 | console.log('Content is cached for offline use.'); 94 | 95 | // Execute callback 96 | if (config && config.onSuccess) { 97 | config.onSuccess(registration); 98 | } 99 | } 100 | } 101 | }; 102 | }; 103 | }) 104 | .catch(error => { 105 | console.error('Error during service worker registration:', error); 106 | }); 107 | } 108 | 109 | function checkValidServiceWorker(swUrl: string, config?: Config) { 110 | // Check if the service worker can be found. If it can't reload the page. 111 | fetch(swUrl, { 112 | headers: { 'Service-Worker': 'script' } 113 | }) 114 | .then(response => { 115 | // Ensure service worker exists, and that we really are getting a JS file. 116 | const contentType = response.headers.get('content-type'); 117 | if ( 118 | response.status === 404 || 119 | (contentType != null && contentType.indexOf('javascript') === -1) 120 | ) { 121 | // No service worker found. Probably a different app. Reload the page. 122 | navigator.serviceWorker.ready.then(registration => { 123 | registration.unregister().then(() => { 124 | window.location.reload(); 125 | }); 126 | }); 127 | } else { 128 | // Service worker found. Proceed as normal. 129 | registerValidSW(swUrl, config); 130 | } 131 | }) 132 | .catch(() => { 133 | console.log( 134 | 'No internet connection found. App is running in offline mode.' 135 | ); 136 | }); 137 | } 138 | 139 | export function unregister() { 140 | if ('serviceWorker' in navigator) { 141 | navigator.serviceWorker.ready 142 | .then(registration => { 143 | registration.unregister(); 144 | }) 145 | .catch(error => { 146 | console.error(error.message); 147 | }); 148 | } 149 | } 150 | -------------------------------------------------------------------------------- /signal-protocol-client/README.md: -------------------------------------------------------------------------------- 1 | # Signal Protocol TypeScript SDK Demo Web Chat App 2 | This is a simple web chat app that uses the Signal Protocol for end-to-end encryption. It acts as a client 3 | to a simple back end system that provides a key registry and message passing service. Instead of phone numbers, 4 | this app allows users to select any username string they like, as long as it is not taken. There is no group chat. 5 | 6 | _This is not a demonstration of how to write a chat app! It is a demonstration of how to use the [TypeScript Signal Protocol SDK]()._ 7 | The chat components are kept a simple as possible so they do not get in the way. 8 | 9 | To use the app, you will need 10 | to provide your own backend service, but with an AWS account this can be done in a few minutes using 11 | [this backend demo project](https://github.com/privacyresearchgroup/signal-demo-backend). 12 | 13 | For a simpler project that demonstrates SDK usage without the complexities of backend access and state management, 14 | please see the [simple]() demo in this repository. 15 | 16 | Since the purpose of this project is to demonstrate use of the Signal Protocol SDK, we will look at the code 17 | organizationbefore giving instructions for deployment and usage. 18 | 19 | ## Code Organization 20 | 21 | The code in this project is organized around the three main tasks we need to complete to use the Signal Protocol: 22 | 23 | * `src/identity`: Creating, registering, and accessing keys 24 | * `src/sessions`: Key exchange, starting a new session 25 | * `src/messages`: sending and receiving encrypted messages 26 | 27 | In addition there are two important directories without UI components: 28 | 29 | * `src/signal`: Key registry API access and in-memory key storage for the Signal Protocol 30 | * `src/network`: Network configuration information and websocket message handling 31 | 32 | Each of these areas are described in more detail below. 33 | 34 | This is a simple React application that uses [rxjs](https://rxjs.dev/) for state management. In each relevant directory there is a `ui/` 35 | subdirectory where UI components can be found. 36 | 37 | ### `src/signal` 38 | The directory `src/signal` contains the functions, API calls, and UI components needed to create an identity with a username and keys, 39 | register this identity with the backend service, and access public information about other registered users: 40 | 41 | * [`src/signal/signal-directory.ts`](): This provides access to the backend REST API that stores and serves user key bundles. 42 | * [`src/signal/signal-store.ts`](): An in-memory key-value store that implements the `StorageType` interface expected by the 43 | Signal Protocol TypeScript and JavaScript SDKs. 44 | 45 | ### `src/identity` 46 | This directory contains the UI components, state management, and functions needed to create an identity for the application. To understand 47 | how to use the Signal Protocol SDK, look at: 48 | 49 | * [`src/identity/functions.ts`](): Brings the directory and the `SignalStore` together in the function `createIdentity`, which generates 50 | keys, stores the private keys in the `SignalStore`, and registers the username and public keys with the server. 51 | 52 | ### `sessions` 53 | A session encapsulates all of the information about a conversation between two parties. The cryptographic information about 54 | a session is managed in the `SignalStore`, so most of the code in this directory is devoted to state management and UI. The 55 | only Signal Protocol logic in this directory is found here: 56 | 57 | * [src/sessions/functions.ts](): The function `startSession` calls the directory API to fetch a pre-key bundle for a remote user, 58 | processes it with a Signal SDK `SessionBuilder` object, then creates a `PreKeyWhisperMessage` which it sends to the remote user 59 | to start the session. 60 | 61 | ### `src/messages` 62 | This directory contains the core logic for sending and receiving encrypted messages. The key functions are here: 63 | 64 | * [src/messages/functions.ts](): Functions to decrypt and process incoming pre-key messages and regular messages. Functions to 65 | encrypt and send outgoing messages 66 | 67 | Also of note in this directory is the file [`src/messages/api.ts`]() which sets up the websocket subscrption and sends messages over 68 | the websocket. 69 | 70 | ## Getting Started 71 | 72 | ### Running Locally 73 | To run this locally: 74 | ``` 75 | yarn start 76 | ``` 77 | Note that this application uses `window.crypto.subtle`, which is only available at `localhost` or ovewr an HTTPS connection. 78 | In particular you will not be able to use it over your local network, even though it may be accessible at, e.g., `http://192.168.1.14:3000`. 79 | 80 | ### Deploying a Backend 81 | This application works with the interface exposed by [this demo serverless backend](https://github.com/privacyresearchgroup/signal-demo-backend). 82 | With an AWS account, AWS CLI tools, [yarn](https://yarnpkg.com/), and [Serverless](https://www.serverless.com/) installed, you can deploy your own backend in minutes. Simply: 83 | 84 | ``` 85 | git clone git@github.com:privacyresearchgroup/signal-demo-backend.git 86 | cd signal-demo-backend 87 | yarn 88 | sls deploy --stage mystagename --aws-profile myawsprofile 89 | ``` 90 | The output of the last command will include the REST API URL, the websocket URI, and the API key needed to configure the client. This information will all be 91 | available in the AWS console, too. 92 | 93 | See the [github repository](https://github.com/privacyresearchgroup/signal-demo-backend) for the backend service for more information. 94 | 95 | ### Using the Deployed Version 96 | This app is deployed at [https://signal-backend-demo.privacyresearch.io](https://signal-backend-demo.privacyresearch.io/). When you're testing you can send messages 97 | from here to your local app as long as you configure them to use the same API URL and websocket URL. 98 | 99 | ### App Usage 100 | To use the app: 101 | 102 | 1. When first visiting you will see a form asking you to enter a user name and some network information (API URL, Websocket URI, and API Key). 103 | The network information is available from the backend deployment described above. Enter this information and presss the "Create Identity" button. 104 | _This creates a new key set and registers it with the directory service. It also initializes the websocket to decrypt incoming messages._ 105 | 2. You now see the _Chat Sessions_ screen. If you know the name of another active user, you can type that name into the text box at the bottom of 106 | the screen and press the "Start Session" button. If you do not know the username of another active user, you can open a new window, go back to Step 1, 107 | and create a new user with a new username. 108 | _This downloads the remote user's key bundle from the directory, generates a `PreKeyWhisperMessage` for the remote user, and sends it._ 109 | 3. Once you start a session with a user, the session will show up in the Chat Sessions list. Click the "(view)" button to view the chat. USe the text 110 | input at the bottom of the screen to send messages. _This will encrypt and send the emssage to the remote user._ 111 | 112 | ## Miscellany 113 | This application uses [craco](https://www.npmjs.com/package/@craco/craco) for two reasons: 114 | 115 | 1. To support TypeScript path mappings 116 | 2. To ignore unused references to `fs` and `path` inserted by emscripten in the [`curve25519-typescript`](https://github.com/privacyresearchgroup/curve25519-typescript) package. 117 | 118 | ## License 119 | 120 | 121 | This project is licensed under [GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html). 122 | 123 | Copyright 2022 - Privacy Research, LLC -------------------------------------------------------------------------------- /simple/src/storage-type.ts: -------------------------------------------------------------------------------- 1 | /* eslint-disable @typescript-eslint/no-explicit-any */ 2 | import { StorageType, Direction, SessionRecordType, SignalProtocolAddress, PreKeyPairType, SignedPreKeyPairType } from '@privacyresearch/libsignal-protocol-typescript' 3 | 4 | // Type guards 5 | export function isKeyPairType(kp: any): kp is KeyPairType { 6 | return !!(kp?.privKey && kp?.pubKey) 7 | } 8 | 9 | export function isPreKeyType(pk: any): pk is PreKeyPairType { 10 | return typeof pk?.keyId === 'number' && isKeyPairType(pk?.keyPair) 11 | } 12 | 13 | export function isSignedPreKeyType(spk: any): spk is SignedPreKeyPairType { 14 | return spk?.signature && isPreKeyType(spk) 15 | } 16 | 17 | interface KeyPairType { 18 | pubKey: ArrayBuffer 19 | privKey: ArrayBuffer 20 | } 21 | 22 | interface PreKeyType { 23 | keyId: number 24 | keyPair: KeyPairType 25 | } 26 | interface SignedPreKeyType extends PreKeyType { 27 | signature: ArrayBuffer 28 | } 29 | 30 | function isArrayBuffer(thing: StoreValue): boolean { 31 | const t = typeof thing 32 | return !!thing && t !== 'string' && t !== 'number' && 'byteLength' in (thing as any) 33 | } 34 | 35 | type StoreValue = KeyPairType | string | number | KeyPairType | PreKeyType | SignedPreKeyType | ArrayBuffer | undefined 36 | 37 | export class SignalProtocolStore implements StorageType { 38 | private _store: Record 39 | 40 | constructor() { 41 | this._store = {} 42 | } 43 | // 44 | get(key: string, defaultValue: StoreValue): StoreValue { 45 | if (key === null || key === undefined) throw new Error('Tried to get value for undefined/null key') 46 | if (key in this._store) { 47 | return this._store[key] 48 | } else { 49 | return defaultValue 50 | } 51 | } 52 | remove(key: string): void { 53 | if (key === null || key === undefined) throw new Error('Tried to remove value for undefined/null key') 54 | delete this._store[key] 55 | } 56 | put(key: string, value: StoreValue): void { 57 | if (key === undefined || value === undefined || key === null || value === null) 58 | throw new Error('Tried to store undefined/null') 59 | this._store[key] = value 60 | } 61 | 62 | async getIdentityKeyPair(): Promise { 63 | const kp = this.get('identityKey', undefined) 64 | if (isKeyPairType(kp) || typeof kp === 'undefined') { 65 | return kp 66 | } 67 | throw new Error('Item stored as identity key of unknown type.') 68 | } 69 | 70 | async getLocalRegistrationId(): Promise { 71 | const rid = this.get('registrationId', undefined) 72 | if (typeof rid === 'number' || typeof rid === 'undefined') { 73 | return rid 74 | } 75 | throw new Error('Stored Registration ID is not a number') 76 | } 77 | isTrustedIdentity( 78 | identifier: string, 79 | identityKey: ArrayBuffer, 80 | // eslint-disable-next-line @typescript-eslint/no-unused-vars 81 | _direction: Direction 82 | ): Promise { 83 | if (identifier === null || identifier === undefined) { 84 | throw new Error('tried to check identity key for undefined/null key') 85 | } 86 | const trusted = this.get('identityKey' + identifier, undefined) 87 | 88 | // TODO: Is this right? If the ID is NOT in our store we trust it? 89 | if (trusted === undefined) { 90 | return Promise.resolve(true) 91 | } 92 | return Promise.resolve( 93 | arrayBufferToString(identityKey) === arrayBufferToString(trusted as ArrayBuffer) 94 | ) 95 | } 96 | async loadPreKey(keyId: string | number): Promise { 97 | let res = this.get('25519KeypreKey' + keyId, undefined) 98 | if (isKeyPairType(res)) { 99 | res = { pubKey: res.pubKey, privKey: res.privKey } 100 | return res 101 | } else if (typeof res === 'undefined') { 102 | return res 103 | } 104 | throw new Error(`stored key has wrong type`) 105 | } 106 | async loadSession(identifier: string): Promise { 107 | const rec = this.get('session' + identifier, undefined) 108 | if (typeof rec === 'string') { 109 | return rec as string 110 | } else if (typeof rec === 'undefined') { 111 | return rec 112 | } 113 | throw new Error(`session record is not an ArrayBuffer`) 114 | } 115 | 116 | async loadSignedPreKey(keyId: number | string): Promise { 117 | const res = this.get('25519KeysignedKey' + keyId, undefined) 118 | if (isKeyPairType(res)) { 119 | return { pubKey: res.pubKey, privKey: res.privKey } 120 | } else if (typeof res === 'undefined') { 121 | return res 122 | } 123 | throw new Error(`stored key has wrong type`) 124 | } 125 | async removePreKey(keyId: number | string): Promise { 126 | this.remove('25519KeypreKey' + keyId) 127 | } 128 | async saveIdentity(identifier: string, identityKey: ArrayBuffer): Promise { 129 | if (identifier === null || identifier === undefined) 130 | throw new Error('Tried to put identity key for undefined/null key') 131 | 132 | const address = SignalProtocolAddress.fromString(identifier) 133 | 134 | const existing = this.get('identityKey' + address.getName(), undefined) 135 | this.put('identityKey' + address.getName(), identityKey) 136 | if (existing && !isArrayBuffer(existing)) { 137 | throw new Error('Identity Key is incorrect type') 138 | } 139 | 140 | if (existing && arrayBufferToString(identityKey) !== arrayBufferToString(existing as ArrayBuffer)) { 141 | return true 142 | } else { 143 | return false 144 | } 145 | } 146 | async storeSession(identifier: string, record: SessionRecordType): Promise { 147 | return this.put('session' + identifier, record) 148 | } 149 | async loadIdentityKey(identifier: string): Promise { 150 | if (identifier === null || identifier === undefined) { 151 | throw new Error('Tried to get identity key for undefined/null key') 152 | } 153 | 154 | const key = this.get('identityKey' + identifier, undefined) 155 | if (isArrayBuffer(key)) { 156 | return key as ArrayBuffer 157 | } else if (typeof key === 'undefined') { 158 | return key 159 | } 160 | throw new Error(`Identity key has wrong type`) 161 | } 162 | async storePreKey(keyId: number | string, keyPair: KeyPairType): Promise { 163 | return this.put('25519KeypreKey' + keyId, keyPair) 164 | } 165 | 166 | // TODO: Why is this keyId a number where others are strings? 167 | async storeSignedPreKey(keyId: number | string, keyPair: KeyPairType): Promise { 168 | return this.put('25519KeysignedKey' + keyId, keyPair) 169 | } 170 | async removeSignedPreKey(keyId: number | string): Promise { 171 | return this.remove('25519KeysignedKey' + keyId) 172 | } 173 | async removeSession(identifier: string): Promise { 174 | return this.remove('session' + identifier) 175 | } 176 | async removeAllSessions(identifier: string): Promise { 177 | for (const id in this._store) { 178 | if (id.startsWith('session' + identifier)) { 179 | delete this._store[id] 180 | } 181 | } 182 | } 183 | } 184 | 185 | export function arrayBufferToString(b: ArrayBuffer): string { 186 | return uint8ArrayToString(new Uint8Array(b)) 187 | } 188 | 189 | export function uint8ArrayToString(arr: Uint8Array): string { 190 | const end = arr.length 191 | let begin = 0 192 | if (begin === end) return '' 193 | let chars: number[] = [] 194 | const parts: string[] = [] 195 | while (begin < end) { 196 | chars.push(arr[begin++]) 197 | if (chars.length >= 1024) { 198 | parts.push(String.fromCharCode(...chars)) 199 | chars = [] 200 | } 201 | } 202 | return parts.join('') + String.fromCharCode(...chars) 203 | } -------------------------------------------------------------------------------- /signal-protocol-client/src/signal/signal-store.ts: -------------------------------------------------------------------------------- 1 | /* eslint-disable @typescript-eslint/no-explicit-any */ 2 | import { 3 | StorageType, 4 | Direction, 5 | SessionRecordType, 6 | SignalProtocolAddress, 7 | PreKeyPairType, 8 | SignedPreKeyPairType, 9 | } from '@privacyresearch/libsignal-protocol-typescript' 10 | 11 | // Type guards 12 | export function isKeyPairType(kp: any): kp is KeyPairType { 13 | return !!(kp?.privKey && kp?.pubKey) 14 | } 15 | 16 | export function isPreKeyType(pk: any): pk is PreKeyPairType { 17 | return typeof pk?.keyId === 'number' && isKeyPairType(pk?.keyPair) 18 | } 19 | 20 | export function isSignedPreKeyType(spk: any): spk is SignedPreKeyPairType { 21 | return spk?.signature && isPreKeyType(spk) 22 | } 23 | 24 | interface KeyPairType { 25 | pubKey: ArrayBuffer 26 | privKey: ArrayBuffer 27 | } 28 | 29 | interface PreKeyType { 30 | keyId: number 31 | keyPair: KeyPairType 32 | } 33 | interface SignedPreKeyType extends PreKeyType { 34 | signature: ArrayBuffer 35 | } 36 | 37 | function isArrayBuffer(thing: StoreValue): boolean { 38 | const t = typeof thing 39 | return !!thing && t !== 'string' && t !== 'number' && 'byteLength' in (thing as any) 40 | } 41 | 42 | type StoreValue = KeyPairType | string | number | KeyPairType | PreKeyType | SignedPreKeyType | ArrayBuffer | undefined 43 | 44 | export class SignalProtocolStore implements StorageType { 45 | private _store: Record 46 | 47 | constructor() { 48 | this._store = {} 49 | } 50 | 51 | get(key: string, defaultValue: StoreValue): StoreValue { 52 | if (key === null || key === undefined) throw new Error('Tried to get value for undefined/null key') 53 | if (key in this._store) { 54 | return this._store[key] 55 | } else { 56 | return defaultValue 57 | } 58 | } 59 | remove(key: string): void { 60 | if (key === null || key === undefined) throw new Error('Tried to remove value for undefined/null key') 61 | delete this._store[key] 62 | } 63 | put(key: string, value: StoreValue): void { 64 | if (key === undefined || value === undefined || key === null || value === null) 65 | throw new Error('Tried to store undefined/null') 66 | this._store[key] = value 67 | } 68 | 69 | async getIdentityKeyPair(): Promise { 70 | const kp = this.get('identityKey', undefined) 71 | if (isKeyPairType(kp) || typeof kp === 'undefined') { 72 | return kp 73 | } 74 | throw new Error('Item stored as identity key of unknown type.') 75 | } 76 | 77 | async getLocalRegistrationId(): Promise { 78 | const rid = this.get('registrationId', undefined) 79 | if (typeof rid === 'number' || typeof rid === 'undefined') { 80 | return rid 81 | } 82 | throw new Error('Stored Registration ID is not a number') 83 | } 84 | isTrustedIdentity( 85 | identifier: string, 86 | identityKey: ArrayBuffer, 87 | // eslint-disable-next-line @typescript-eslint/no-unused-vars 88 | _direction: Direction 89 | ): Promise { 90 | if (identifier === null || identifier === undefined) { 91 | throw new Error('tried to check identity key for undefined/null key') 92 | } 93 | const trusted = this.get('identityKey' + identifier, undefined) 94 | 95 | // TODO: Is this right? If the ID is NOT in our store we trust it? 96 | if (trusted === undefined) { 97 | return Promise.resolve(true) 98 | } 99 | return Promise.resolve(arrayBufferToString(identityKey) === arrayBufferToString(trusted as ArrayBuffer)) 100 | } 101 | async loadPreKey(keyId: string | number): Promise { 102 | let res = this.get('25519KeypreKey' + keyId, undefined) 103 | if (isKeyPairType(res)) { 104 | res = { pubKey: res.pubKey, privKey: res.privKey } 105 | return res 106 | } else if (typeof res === 'undefined') { 107 | return res 108 | } 109 | throw new Error(`stored key has wrong type`) 110 | } 111 | async loadSession(identifier: string): Promise { 112 | const rec = this.get('session' + identifier, undefined) 113 | if (typeof rec === 'string') { 114 | return rec as string 115 | } else if (typeof rec === 'undefined') { 116 | return rec 117 | } 118 | throw new Error(`session record is not an ArrayBuffer`) 119 | } 120 | 121 | async loadSignedPreKey(keyId: number | string): Promise { 122 | const res = this.get('25519KeysignedKey' + keyId, undefined) 123 | if (isKeyPairType(res)) { 124 | return { pubKey: res.pubKey, privKey: res.privKey } 125 | } else if (typeof res === 'undefined') { 126 | return res 127 | } 128 | throw new Error(`stored key has wrong type`) 129 | } 130 | async removePreKey(keyId: number | string): Promise { 131 | this.remove('25519KeypreKey' + keyId) 132 | } 133 | async saveIdentity(identifier: string, identityKey: ArrayBuffer): Promise { 134 | if (identifier === null || identifier === undefined) 135 | throw new Error('Tried to put identity key for undefined/null key') 136 | 137 | const address = SignalProtocolAddress.fromString(identifier) 138 | 139 | const existing = this.get('identityKey' + address.getName(), undefined) 140 | this.put('identityKey' + address.getName(), identityKey) 141 | if (existing && !isArrayBuffer(existing)) { 142 | throw new Error('Identity Key is incorrect type') 143 | } 144 | 145 | if (existing && arrayBufferToString(identityKey) !== arrayBufferToString(existing as ArrayBuffer)) { 146 | return true 147 | } else { 148 | return false 149 | } 150 | } 151 | async storeSession(identifier: string, record: SessionRecordType): Promise { 152 | return this.put('session' + identifier, record) 153 | } 154 | async loadIdentityKey(identifier: string): Promise { 155 | if (identifier === null || identifier === undefined) { 156 | throw new Error('Tried to get identity key for undefined/null key') 157 | } 158 | 159 | const key = this.get('identityKey' + identifier, undefined) 160 | if (isArrayBuffer(key)) { 161 | return key as ArrayBuffer 162 | } else if (typeof key === 'undefined') { 163 | return key 164 | } 165 | throw new Error(`Identity key has wrong type`) 166 | } 167 | async storePreKey(keyId: number | string, keyPair: KeyPairType): Promise { 168 | return this.put('25519KeypreKey' + keyId, keyPair) 169 | } 170 | 171 | // TODO: Why is this keyId a number where others are strings? 172 | async storeSignedPreKey(keyId: number | string, keyPair: KeyPairType): Promise { 173 | return this.put('25519KeysignedKey' + keyId, keyPair) 174 | } 175 | async removeSignedPreKey(keyId: number | string): Promise { 176 | return this.remove('25519KeysignedKey' + keyId) 177 | } 178 | async removeSession(identifier: string): Promise { 179 | return this.remove('session' + identifier) 180 | } 181 | async removeAllSessions(identifier: string): Promise { 182 | for (const id in this._store) { 183 | if (id.startsWith('session' + identifier)) { 184 | delete this._store[id] 185 | } 186 | } 187 | } 188 | } 189 | 190 | export function arrayBufferToString(b: ArrayBuffer): string { 191 | return uint8ArrayToString(new Uint8Array(b)) 192 | } 193 | 194 | export function uint8ArrayToString(arr: Uint8Array): string { 195 | const end = arr.length 196 | let begin = 0 197 | if (begin === end) return '' 198 | let chars: number[] = [] 199 | const parts: string[] = [] 200 | while (begin < end) { 201 | chars.push(arr[begin++]) 202 | if (chars.length >= 1024) { 203 | parts.push(String.fromCharCode(...chars)) 204 | chars = [] 205 | } 206 | } 207 | return parts.join('') + String.fromCharCode(...chars) 208 | } 209 | -------------------------------------------------------------------------------- /simple/src/App.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState, useEffect } from "react"; 2 | import { makeStyles } from "@material-ui/core/styles"; 3 | 4 | import ReactMarkdown from "react-markdown"; 5 | 6 | import { 7 | KeyHelper, 8 | SignedPublicPreKeyType, 9 | SignalProtocolAddress, 10 | SessionBuilder, 11 | PreKeyType, 12 | SessionCipher, 13 | MessageType, 14 | } from "@privacyresearch/libsignal-protocol-typescript"; 15 | 16 | import "./App.css"; 17 | import { 18 | Paper, 19 | Grid, 20 | Avatar, 21 | Typography, 22 | Button, 23 | Chip, 24 | TextField, 25 | } from "@material-ui/core"; 26 | import SendIcon from "@material-ui/icons/Send"; 27 | 28 | import { SignalProtocolStore } from "./storage-type"; 29 | import { SignalDirectory } from "./signal-directory"; 30 | import CodeBlock from "./code-block"; 31 | 32 | const initialStory = 33 | "# Start using the demo to see what is happening in the code"; 34 | const createidMD = "createid.md"; 35 | const startSessionWithAMD = "start-session-with-a.md"; 36 | const startSessionWithBMD = "start-session-with-b.md"; 37 | const sendMessageMD = "send-message.md"; 38 | 39 | const useStyles = makeStyles((theme) => ({ 40 | root: { 41 | flexGrow: 1, 42 | }, 43 | paper: { 44 | padding: theme.spacing(2), 45 | margin: "auto", 46 | maxWidth: "90%", 47 | }, 48 | image: { 49 | width: 128, 50 | height: 128, 51 | }, 52 | container: { 53 | padding: theme.spacing(2), 54 | }, 55 | buttonitem: { 56 | margin: 10, 57 | padding: 10, 58 | }, 59 | message: { 60 | padding: 10, 61 | backgroundColor: "lightsteelblue", 62 | margin: 10, 63 | maxWidth: "90%", 64 | textAlign: "left", 65 | }, 66 | outgoingmessage: { 67 | padding: 10, 68 | backgroundColor: "linen", 69 | margin: 10, 70 | maxWidth: "90%", 71 | }, 72 | img: { 73 | margin: "auto", 74 | display: "block", 75 | maxWidth: "100%", 76 | maxHeight: "100%", 77 | }, 78 | story: { 79 | margin: "auto", 80 | display: "block", 81 | textAlign: "left", 82 | fontSize: "10pt", 83 | }, 84 | })); 85 | 86 | interface ChatMessage { 87 | id: number; 88 | to: string; 89 | from: string; 90 | message: MessageType; 91 | delivered: boolean; 92 | } 93 | interface ProcessedChatMessage { 94 | id: number; 95 | to: string; 96 | from: string; 97 | messageText: string; 98 | } 99 | let msgID = 0; 100 | 101 | function getNewMessageID(): number { 102 | return msgID++; 103 | } 104 | 105 | // define addresses 106 | 107 | const adalheidAddress = new SignalProtocolAddress("adalheid", 1); 108 | const brunhildeAddress = new SignalProtocolAddress("brünhild", 1); 109 | 110 | function App() { 111 | const [adiStore] = useState(new SignalProtocolStore()); 112 | const [brunhildeStore] = useState(new SignalProtocolStore()); 113 | 114 | const [aHasIdentity, setAHasIdentity] = useState(false); 115 | const [bHasIdentity, setBHasIdentity] = useState(false); 116 | 117 | const [directory] = useState(new SignalDirectory()); 118 | const [messages, setMessages] = useState([]); 119 | const [processedMessages, setProcessedMessages] = useState< 120 | ProcessedChatMessage[] 121 | >([]); 122 | 123 | const [hasSession, setHasSession] = useState(false); 124 | 125 | const [adalheidTyping, setAdalheidTyping] = useState(""); 126 | const [brunhildeTyping, setBrunhildeTyping] = useState(""); 127 | 128 | const [processing, setProcessing] = useState(false); 129 | const [story, setStory] = useState(initialStory); 130 | 131 | 132 | const classes = useStyles(); 133 | 134 | const updateStory = async (url: string) => { 135 | const resp = await fetch(url); 136 | const md = await resp.text(); 137 | setStory(md); 138 | }; 139 | 140 | const sendMessage = (to: string, from: string, message: MessageType) => { 141 | const msg = { to, from, message, delivered: false, id: getNewMessageID() }; 142 | setMessages([...messages, msg]); 143 | }; 144 | 145 | useEffect(() => { 146 | if (!messages.find((m) => !m.delivered) || processing) { 147 | return; 148 | } 149 | 150 | const getReceivingSessionCipherForRecipient = (to: string) => { 151 | // send from Brünhild to Adalheid so use his store 152 | const store = to === "brünhild" ? brunhildeStore : adiStore; 153 | const address = to === "brünhild" ? adalheidAddress : brunhildeAddress; 154 | return new SessionCipher(store, address); 155 | }; 156 | 157 | const doProcessing = async () => { 158 | while (messages.length > 0) { 159 | const nextMsg = messages.shift(); 160 | if (!nextMsg) { 161 | continue; 162 | } 163 | const cipher = getReceivingSessionCipherForRecipient(nextMsg.to); 164 | const processed = await readMessage(nextMsg, cipher); 165 | processedMessages.push(processed); 166 | } 167 | setMessages([...messages]); 168 | setProcessedMessages([...processedMessages]); 169 | }; 170 | setProcessing(true); 171 | doProcessing().then(() => { 172 | setProcessing(false); 173 | }); 174 | }, [adiStore, brunhildeStore, messages, processedMessages, processing]); 175 | 176 | const readMessage = async (msg: ChatMessage, cipher: SessionCipher) => { 177 | let plaintext: ArrayBuffer = new Uint8Array().buffer; 178 | if (msg.message.type === 3) { 179 | console.log({ msg }); 180 | plaintext = await cipher.decryptPreKeyWhisperMessage( 181 | msg.message.body!, 182 | "binary" 183 | ); 184 | setHasSession(true); 185 | } else if (msg.message.type === 1) { 186 | plaintext = await cipher.decryptWhisperMessage( 187 | msg.message.body!, 188 | "binary" 189 | ); 190 | } 191 | const stringPlaintext = new TextDecoder().decode(new Uint8Array(plaintext)); 192 | console.log(stringPlaintext); 193 | 194 | const { id, to, from } = msg; 195 | return { id, to, from, messageText: stringPlaintext }; 196 | }; 197 | 198 | const storeSomewhereSafe = (store: SignalProtocolStore) => ( 199 | key: string, 200 | value: any 201 | ) => { 202 | store.put(key, value); 203 | }; 204 | 205 | const createID = async (name: string, store: SignalProtocolStore) => { 206 | const registrationId = KeyHelper.generateRegistrationId(); 207 | // Store registrationId somewhere durable and safe... Or do this. 208 | storeSomewhereSafe(store)(`registrationID`, registrationId); 209 | 210 | const identityKeyPair = await KeyHelper.generateIdentityKeyPair(); 211 | // Store identityKeyPair somewhere durable and safe... Or do this. 212 | storeSomewhereSafe(store)("identityKey", identityKeyPair); 213 | 214 | const baseKeyId = Math.floor(10000 * Math.random()); 215 | const preKey = await KeyHelper.generatePreKey(baseKeyId); 216 | store.storePreKey(`${baseKeyId}`, preKey.keyPair); 217 | 218 | const signedPreKeyId = Math.floor(10000 * Math.random()); 219 | const signedPreKey = await KeyHelper.generateSignedPreKey( 220 | identityKeyPair, 221 | signedPreKeyId 222 | ); 223 | store.storeSignedPreKey(signedPreKeyId, signedPreKey.keyPair); 224 | const publicSignedPreKey: SignedPublicPreKeyType = { 225 | keyId: signedPreKeyId, 226 | publicKey: signedPreKey.keyPair.pubKey, 227 | signature: signedPreKey.signature, 228 | }; 229 | 230 | // Now we register this with the server so all users can see them 231 | const publicPreKey: PreKeyType = { 232 | keyId: preKey.keyId, 233 | publicKey: preKey.keyPair.pubKey, 234 | }; 235 | directory.storeKeyBundle(name, { 236 | registrationId, 237 | identityPubKey: identityKeyPair.pubKey, 238 | signedPreKey: publicSignedPreKey, 239 | oneTimePreKeys: [publicPreKey], 240 | }); 241 | updateStory(createidMD); 242 | }; 243 | 244 | const createAdalheidIdentity = async () => { 245 | await createID("adalheid", adiStore); 246 | console.log({ adiStore }); 247 | setAHasIdentity(true); 248 | }; 249 | 250 | const createBrunhildeIdentity = async () => { 251 | await createID("brünhild", brunhildeStore); 252 | setBHasIdentity(true); 253 | }; 254 | 255 | const starterMessageBytes = Uint8Array.from([ 256 | 0xce, 257 | 0x93, 258 | 0xce, 259 | 0xb5, 260 | 0xce, 261 | 0xb9, 262 | 0xce, 263 | 0xac, 264 | 0x20, 265 | 0xcf, 266 | 0x83, 267 | 0xce, 268 | 0xbf, 269 | 0xcf, 270 | 0x85, 271 | ]); 272 | 273 | const startSessionWithBrunhilde = async () => { 274 | // get Brünhild' key bundle 275 | const brunhildeBundle = directory.getPreKeyBundle("brünhild"); 276 | console.log({ brunhildeBundle }); 277 | 278 | const recipientAddress = brunhildeAddress; 279 | 280 | // Instantiate a SessionBuilder for a remote recipientId + deviceId tuple. 281 | const sessionBuilder = new SessionBuilder(adiStore, recipientAddress); 282 | 283 | // Process a prekey fetched from the server. Returns a promise that resolves 284 | // once a session is created and saved in the store, or rejects if the 285 | // identityKey differs from a previously seen identity for this address. 286 | console.log("adalheid processing prekey"); 287 | await sessionBuilder.processPreKey(brunhildeBundle!); 288 | 289 | // Now we can send an encrypted message 290 | const adalheidSessionCipher = new SessionCipher(adiStore, recipientAddress); 291 | const ciphertext = await adalheidSessionCipher.encrypt( 292 | starterMessageBytes.buffer 293 | ); 294 | 295 | sendMessage("brünhild", "adalheid", ciphertext); 296 | updateStory(startSessionWithBMD); 297 | }; 298 | 299 | const startSessionWithAdalheid = async () => { 300 | // get Adalheid's key bundle 301 | const adalheidBundle = directory.getPreKeyBundle("adalheid"); 302 | console.log({ adalheidBundle }); 303 | 304 | const recipientAddress = adalheidAddress; 305 | 306 | // Instantiate a SessionBuilder for a remote recipientId + deviceId tuple. 307 | const sessionBuilder = new SessionBuilder(brunhildeStore, recipientAddress); 308 | 309 | // Process a prekey fetched from the server. Returns a promise that resolves 310 | // once a session is created and saved in the store, or rejects if the 311 | // identityKey differs from a previously seen identity for this address. 312 | console.log("brünhild processing prekey"); 313 | await sessionBuilder.processPreKey(adalheidBundle!); 314 | 315 | // Now we can send an encrypted message 316 | const brunhildeSessionCipher = new SessionCipher( 317 | brunhildeStore, 318 | recipientAddress 319 | ); 320 | const ciphertext = await brunhildeSessionCipher.encrypt( 321 | starterMessageBytes.buffer 322 | ); 323 | 324 | sendMessage("adalheid", "brünhild", ciphertext); 325 | updateStory(startSessionWithAMD); 326 | }; 327 | 328 | const displayMessages = (sender: string) => { 329 | return processedMessages.map((m) => ( 330 | 331 | {m.from === sender ? :
    } 332 | 333 | 338 | {m.messageText} 339 | 340 | 341 | {m.from !== sender ? :
    } 342 | 343 | )); 344 | }; 345 | 346 | const getSessionCipherForRecipient = (to: string) => { 347 | // send from Brünhild to adalheid so use his store 348 | const store = to === "adalheid" ? brunhildeStore : adiStore; 349 | const address = to === "adalheid" ? adalheidAddress : brunhildeAddress; 350 | return new SessionCipher(store, address); 351 | }; 352 | 353 | const encryptAndSendMessage = async (to: string, message: string) => { 354 | const cipher = getSessionCipherForRecipient(to); 355 | const from = to === "adalheid" ? "brünhild" : "adalheid"; 356 | const ciphertext = await cipher.encrypt( 357 | new TextEncoder().encode(message).buffer 358 | ); 359 | if (from === "adalheid") { 360 | setAdalheidTyping(""); 361 | } else { 362 | setBrunhildeTyping(""); 363 | } 364 | sendMessage(to, from, ciphertext); 365 | updateStory(sendMessageMD); 366 | }; 367 | 368 | const sendMessageControl = (to: string) => { 369 | const value = to === "adalheid" ? brunhildeTyping : adalheidTyping; 370 | const onTextChange = 371 | to === "adalheid" ? setBrunhildeTyping : setAdalheidTyping; 372 | return ( 373 | 374 | 375 | { 381 | onTextChange(event.target.value); 382 | }} 383 | variant="outlined" 384 | > 385 | 393 | 394 | 395 | ); 396 | }; 397 | 398 | return ( 399 |
    400 | 401 | 402 | 403 | 404 | 405 | 406 | 411 | Adalheid's View 412 | 413 | 414 | 415 | 416 | A 417 | 418 | 419 | {aHasIdentity ? ( 420 | 421 | 427 | {hasSession || !(aHasIdentity && bHasIdentity) ? ( 428 |
    429 | ) : ( 430 | 437 | )} 438 | 439 | ) : ( 440 | 447 | )} 448 | 449 | {hasSession ? sendMessageControl("brünhild") :
    } 450 | {displayMessages("adalheid")} 451 | 452 | 453 | 454 | 455 | 456 | 457 | Adalheid talks to Brünhild 458 | 459 | 465 | 466 | 467 | 468 | 469 | 470 | 471 | B 472 | 473 | 474 | 479 | Brünhild's View 480 | 481 | 482 | 483 | {bHasIdentity ? ( 484 | 485 | 491 | {hasSession || !(aHasIdentity && bHasIdentity) ? ( 492 |
    493 | ) : ( 494 | 501 | )} 502 | 503 | ) : ( 504 | 510 | )} 511 | 512 | {hasSession ? sendMessageControl("adalheid") :
    } 513 | {displayMessages("brünhild")} 514 | 515 | 516 | 517 | 518 | 519 |
    520 | ); 521 | } 522 | 523 | export default App; 524 | -------------------------------------------------------------------------------- /simple/LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . -------------------------------------------------------------------------------- /signal-protocol-client/LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . --------------------------------------------------------------------------------