├── lib ├── libccurl │ ├── lin64 │ │ └── libccurl.so │ ├── mac │ │ └── libccurl.dylib │ └── win64 │ │ └── libccurl.dll ├── curl.js ├── converter.js ├── iotatools.js ├── iotaproxy.js └── ccurlprovider.js ├── package.json ├── index.js ├── README.md └── LICENSE /lib/libccurl/lin64/libccurl.so: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TimSamshuijzen/iotaproxy/HEAD/lib/libccurl/lin64/libccurl.so -------------------------------------------------------------------------------- /lib/libccurl/mac/libccurl.dylib: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TimSamshuijzen/iotaproxy/HEAD/lib/libccurl/mac/libccurl.dylib -------------------------------------------------------------------------------- /lib/libccurl/win64/libccurl.dll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TimSamshuijzen/iotaproxy/HEAD/lib/libccurl/win64/libccurl.dll -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "iotaproxy", 3 | "version": "1.0.0", 4 | "description": "Simple IOTA Proxy server with attachToTangle/PoW support", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"no test specified\" && exit 1" 8 | }, 9 | "author": { 10 | "name": "Tim Samshuijzen" 11 | }, 12 | "license": "MIT", 13 | "dependencies": { 14 | "ffi": "^2.2.0" 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * Simple proxy server for IOTA. 4 | * Relays commands to the IOTA Tangle, but intercepts attachToTangle commands and performs PoW locally. 5 | * 6 | * This proxy server useful for when you want to perform transfers with iota.lib.js in Node but do not 7 | * have access to a full node that grants you access to the necessary attachToTangle commands. 8 | */ 9 | 10 | var iotaProxy = require('./lib/iotaproxy.js'); 11 | 12 | iotaProxy.start( 13 | { 14 | host: 'http://iota.bitfinex.com', 15 | port: 80, 16 | localPort: 14265, 17 | overrideAttachToTangle: true, 18 | timeout: 15 19 | } 20 | ); 21 | -------------------------------------------------------------------------------- /lib/curl.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * Cryptographic related functions to IOTA's Curl (sponge function) 4 | * 5 | * File copied from: 6 | * https://github.com/iotaledger/wallet 7 | * Licence: GNU General Public License v3.0 8 | * 9 | **/ 10 | 11 | var NUMBER_OF_ROUNDS = 81; 12 | var HASH_LENGTH = 243; 13 | var STATE_LENGTH = 3 * HASH_LENGTH; 14 | 15 | function Curl(rounds) { 16 | if (rounds) { 17 | this.rounds = rounds; 18 | } else { 19 | this.rounds = NUMBER_OF_ROUNDS; 20 | } 21 | // truth table 22 | this.truthTable = [1, 0, -1, 2, 1, -1, 0, 2, -1, 1, 0]; 23 | } 24 | 25 | Curl.HASH_LENGTH = HASH_LENGTH; 26 | 27 | /** 28 | * Initializes the state with STATE_LENGTH trits 29 | * 30 | * @method initialize 31 | **/ 32 | Curl.prototype.initialize = function(state, length) { 33 | 34 | if (state) { 35 | 36 | this.state = state; 37 | 38 | } else { 39 | 40 | this.state = []; 41 | 42 | for (var i = 0; i < STATE_LENGTH; i++) { 43 | 44 | this.state[i] = 0; 45 | 46 | } 47 | } 48 | } 49 | 50 | /** 51 | * Sponge absorb function 52 | * 53 | * @method absorb 54 | **/ 55 | Curl.prototype.absorb = function(trits, offset, length) { 56 | 57 | do { 58 | 59 | var i = 0; 60 | var limit = (length < HASH_LENGTH ? length : HASH_LENGTH); 61 | 62 | while (i < limit) { 63 | 64 | this.state[i++] = trits[offset++]; 65 | } 66 | 67 | this.transform(); 68 | 69 | } while (( length -= HASH_LENGTH ) > 0) 70 | 71 | } 72 | 73 | /** 74 | * Sponge squeeze function 75 | * 76 | * @method squeeze 77 | **/ 78 | Curl.prototype.squeeze = function(trits, offset, length) { 79 | 80 | do { 81 | 82 | var i = 0; 83 | var limit = (length < HASH_LENGTH ? length : HASH_LENGTH); 84 | 85 | while (i < limit) { 86 | 87 | trits[offset++] = this.state[i++]; 88 | } 89 | 90 | this.transform(); 91 | 92 | } while (( length -= HASH_LENGTH ) > 0) 93 | } 94 | 95 | /** 96 | * Sponge transform function 97 | * 98 | * @method transform 99 | **/ 100 | Curl.prototype.transform = function() { 101 | 102 | var stateCopy = [], index = 0; 103 | 104 | for (var round = 0; round < this.rounds; round++) { 105 | 106 | stateCopy = this.state.slice(); 107 | 108 | for (var i = 0; i < STATE_LENGTH; i++) { 109 | 110 | this.state[i] = this.truthTable[stateCopy[index] + (stateCopy[index += (index < 365 ? 364 : -365)] << 2) + 5]; 111 | } 112 | } 113 | } 114 | 115 | module.exports = Curl 116 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # IOTA Proxy 3 | 4 | A simple proxy server for the [IOTA](https://iota.org) tangle network, supporting the attachToTangle command (PoW). 5 | This light weight server will proxy/relay all incoming requests to a public node in the tangle network, but intercepts the attachToTangle command and performs the PoW locally. 6 | 7 | Developers getting to know [iota.lib.js](https://github.com/iotaledger/iota.lib.js) in Node.js may have experienced the 8 | "_COMMAND attachToTangle is not available on this node_" response after calling iota.api.sendTransfer(). 9 | Some others may have experienced the same error message when calling the REST API [attachToTangle](https://iota.readme.io/docs/attachtotangle) command. 10 | The attachToTangle command is a request to perform the PoW that is necessary when doing a transaction. 11 | 12 | Most public full nodes in the IOTA network do not support the [attachToTangle](https://iota.readme.io/docs/attachtotangle) command. 13 | By design it is expected that you do the PoW locally on your device, the network is not required to do this for you. 14 | 15 | If you're looking an easy way to do PoW, then this proxy server might help. 16 | Use this proxy server when you want to offload PoW. 17 | 18 | Feel free to edit or fork! 19 | 20 | If this does proxy server is not what you are looking for, then you can look at some of the methods provided by the IOTA foundation in their [repository](https://github.com/iotaledger). 21 | Some examples of solutions provided by the IOTA foundation: 22 | 23 | * Do PoW in [WebGL2-enabled browsers](https://github.com/iotaledger/curl.lib.js). 24 | * To do PoW in Node.js, combine solutions from [ccurl.interface.js](https://github.com/iotaledger/ccurl.interface.js) 25 | and [ccurl](https://github.com/iotaledger/ccurl.git), and override the iota.api.attachToTangle method in 26 | [iota.lib.js](https://github.com/iotaledger/iota.lib.js). 27 | * Install and run your own full IOTA node, configured to grant you access to the attachToTangle command. 28 | 29 | --- 30 | 31 | > This repository contains code and precompiled libraries from [iotaledger/wallet](https://github.com/iotaledger/wallet). 32 | > Licence: GNU General Public License v3.0 33 | 34 | --- 35 | 36 | ## Prerequisites 37 | 38 | Download and install [Node.js](https://nodejs.org/en/download/) 39 | 40 | 41 | ## Instructions 42 | 43 | 1. Clone this repository: 44 | 45 | ``` 46 | git clone https://github.com/TimSamshuijzen/iotaproxy 47 | ``` 48 | 49 | 2. Enter the "iotaproxy" directory: 50 | 51 | ``` 52 | cd iotaproxy 53 | ``` 54 | 55 | 3. Install dependencies: 56 | 57 | ``` 58 | npm install 59 | ``` 60 | 61 | 4. Edit index.js to set preferred connection settings. For example: 62 | 63 | ``` 64 | var iotaProxy = require('./lib/iotaproxy.js'); 65 | iotaProxy.start( 66 | { 67 | host: 'http://iota.bitfinex.com', 68 | port: 80, 69 | localPort: 14265, 70 | overrideAttachToTangle: true 71 | } 72 | ); 73 | ``` 74 | 75 | 5. Run the proxy server: 76 | 77 | ``` 78 | node --harmony index.js 79 | ``` 80 | 81 | 6. Proxy server is now ready to use. It will start off displaying this in the console: 82 | 83 | ``` 84 | IOTA proxy server started 85 | POW timeout is set to 15 min 86 | Listening on port 14265 87 | Relaying requests to iota.bitfinex.com:80 88 | ``` 89 | 90 | 7. Now, in your [iota.lib.js](https://github.com/iotaledger/iota.lib.js) project you can simply connect to this local proxy server, which in turn connects with the tangle: 91 | 92 | ``` 93 | var IOTA = require('iota.lib.js'); 94 | 95 | var iota = new IOTA({ 96 | 'host': 'http://localhost', 97 | 'port': 14265 98 | }); 99 | ``` 100 | 101 | 102 | 103 | --- 104 | -------------------------------------------------------------------------------- /lib/converter.js: -------------------------------------------------------------------------------- 1 | /** 2 | * 3 | * Conversion functions 4 | * 5 | * File copied from: 6 | * https://github.com/iotaledger/wallet 7 | * Licence: GNU General Public License v3.0 8 | * 9 | **/ 10 | 11 | var RADIX = 3; 12 | var MAX_TRIT_VALUE = 1; 13 | var MIN_TRIT_VALUE = -1; 14 | 15 | // All possible tryte values 16 | var trytesAlphabet = "9ABCDEFGHIJKLMNOPQRSTUVWXYZ" 17 | 18 | // map of all trits representations 19 | var trytesTrits = [ 20 | [ 0, 0, 0], 21 | [ 1, 0, 0], 22 | [-1, 1, 0], 23 | [ 0, 1, 0], 24 | [ 1, 1, 0], 25 | [-1, -1, 1], 26 | [ 0, -1, 1], 27 | [ 1, -1, 1], 28 | [-1, 0, 1], 29 | [ 0, 0, 1], 30 | [ 1, 0, 1], 31 | [-1, 1, 1], 32 | [ 0, 1, 1], 33 | [ 1, 1, 1], 34 | [-1, -1, -1], 35 | [ 0, -1, -1], 36 | [ 1, -1, -1], 37 | [-1, 0, -1], 38 | [ 0, 0, -1], 39 | [ 1, 0, -1], 40 | [-1, 1, -1], 41 | [ 0, 1, -1], 42 | [ 1, 1, -1], 43 | [-1, -1, 0], 44 | [ 0, -1, 0], 45 | [ 1, -1, 0], 46 | [-1, 0, 0] 47 | ]; 48 | 49 | /** 50 | * Converts trytes into trits 51 | * 52 | * @method trits 53 | * @param {String|Int} input Tryte value to be converted. Can either be string or int 54 | * @param {Array} state (optional) state to be modified 55 | * @returns {Array} trits 56 | **/ 57 | var trits = function(input, state) { 58 | 59 | var trits = state || []; 60 | 61 | if (Number.isInteger(input)) { 62 | 63 | var absoluteValue = input < 0 ? -input : input; 64 | 65 | while (absoluteValue > 0) { 66 | 67 | var remainder = absoluteValue % 3; 68 | absoluteValue = Math.floor(absoluteValue / 3); 69 | 70 | if (remainder > 1) { 71 | remainder = -1; 72 | absoluteValue++; 73 | } 74 | 75 | trits[trits.length] = remainder; 76 | } 77 | if (input < 0) { 78 | 79 | for (var i = 0; i < trits.length; i++) { 80 | 81 | trits[i] = -trits[i]; 82 | } 83 | } 84 | } else { 85 | 86 | for (var i = 0; i < input.length; i++) { 87 | 88 | var index = trytesAlphabet.indexOf(input.charAt(i)); 89 | trits[i * 3] = trytesTrits[index][0]; 90 | trits[i * 3 + 1] = trytesTrits[index][1]; 91 | trits[i * 3 + 2] = trytesTrits[index][2]; 92 | } 93 | } 94 | 95 | return trits; 96 | } 97 | 98 | /** 99 | * Converts trits into trytes 100 | * 101 | * @method trytes 102 | * @param {Array} trits 103 | * @returns {String} trytes 104 | **/ 105 | var trytes = function(trits) { 106 | 107 | var trytes = ""; 108 | 109 | for (var i = 0; i < trits.length; i += 3) { 110 | 111 | // Iterate over all possible tryte values to find correct trit representation 112 | for (var j = 0; j < trytesAlphabet.length; j++) { 113 | 114 | if (trytesTrits[j][0] == trits[i] && trytesTrits[j][1] == trits[i + 1] && trytesTrits[j][2] == trits[i + 2]) { 115 | 116 | trytes += trytesAlphabet.charAt(j); 117 | break; 118 | } 119 | } 120 | } 121 | 122 | return trytes; 123 | } 124 | 125 | /** 126 | * Converts trits into an integer value 127 | * 128 | * @method value 129 | * @param {Array} trits 130 | * @returns {String} trytes 131 | **/ 132 | var value = function(trits) { 133 | 134 | var returnValue = 0; 135 | 136 | for (var i = trits.length; i-- > 0; ) { 137 | 138 | returnValue = returnValue * 3 + trits[i]; 139 | } 140 | 141 | return returnValue; 142 | } 143 | 144 | 145 | /** 146 | * Converts an integer value into trits 147 | * 148 | * @method fromValue 149 | * @param {Number} value 150 | * @returns {Array} trits 151 | **/ 152 | var fromValue= function(value) { 153 | var destination = []; 154 | var absoluteValue = value < 0 ? -value : value; 155 | var i = 0; 156 | while(absoluteValue > 0) { 157 | var remainder = (absoluteValue % RADIX); 158 | absoluteValue = Math.floor(absoluteValue / RADIX); 159 | if (remainder > MAX_TRIT_VALUE) { 160 | 161 | remainder = MIN_TRIT_VALUE; 162 | absoluteValue++; 163 | } 164 | destination[i] = remainder; 165 | i++; 166 | } 167 | if (value < 0) { 168 | for (var j = 0; j < destination.length; j++) { 169 | destination[j] = destination[j] == 0 ? 0: -destination[j]; 170 | } 171 | } 172 | return destination; 173 | } 174 | 175 | module.exports = { 176 | trits : trits, 177 | trytes : trytes, 178 | value : value, 179 | fromValue : fromValue, 180 | }; 181 | -------------------------------------------------------------------------------- /lib/iotatools.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /** 4 | * Curl library provider. 5 | * 6 | * Contains code copied from: 7 | * https://github.com/iotaledger/wallet 8 | * Licence: GNU General Public License v3.0 9 | */ 10 | 11 | var Converter = require('./converter.js'); 12 | var Curl = require('./curl.js'); 13 | 14 | let iotaTools = 15 | { 16 | 17 | valid: 18 | { 19 | isTrytes: function(trytes, length) 20 | { 21 | // If no length specified, just validate the trytes 22 | if (!length) length = "0," 23 | 24 | var regexTrytes = new RegExp("^[9A-Z]{" + length +"}$"); 25 | return regexTrytes.test(trytes) && iotaTools.valid.isString(trytes); 26 | }, 27 | 28 | isHash: function(hash) 29 | { 30 | // Check if valid, 81 trytes 31 | if (!iotaTools.valid.isTrytes(hash, 81)) 32 | { 33 | return false; 34 | } 35 | return true; 36 | }, 37 | 38 | isString: function(string) 39 | { 40 | return typeof string === 'string'; 41 | }, 42 | 43 | isValue: function(value) 44 | { 45 | // check if correct number 46 | return Number.isInteger(value) 47 | } 48 | }, 49 | 50 | utils: 51 | { 52 | transactionObject: function(trytes) 53 | { 54 | if (!trytes) return; 55 | 56 | // validity check 57 | for (var i = 2279; i < 2295; i++) 58 | { 59 | if (trytes.charAt(i) !== "9") 60 | { 61 | return null; 62 | } 63 | } 64 | 65 | var thisTransaction = {}; 66 | var transactionTrits = Converter.trits(trytes); 67 | var hash = []; 68 | 69 | var curl = new Curl(); 70 | 71 | // generate the correct transaction hash 72 | curl.initialize(); 73 | curl.absorb(transactionTrits, 0, transactionTrits.length); 74 | curl.squeeze(hash, 0, 243); 75 | 76 | thisTransaction.hash = Converter.trytes(hash); 77 | thisTransaction.signatureMessageFragment = trytes.slice(0, 2187); 78 | thisTransaction.address = trytes.slice(2187, 2268); 79 | thisTransaction.value = Converter.value(transactionTrits.slice(6804, 6837)); 80 | thisTransaction.obsoleteTag = trytes.slice(2295, 2322); 81 | thisTransaction.timestamp = Converter.value(transactionTrits.slice(6966, 6993)); 82 | thisTransaction.currentIndex = Converter.value(transactionTrits.slice(6993, 7020)); 83 | thisTransaction.lastIndex = Converter.value(transactionTrits.slice(7020, 7047)); 84 | thisTransaction.bundle = trytes.slice(2349, 2430); 85 | thisTransaction.trunkTransaction = trytes.slice(2430, 2511); 86 | thisTransaction.branchTransaction = trytes.slice(2511, 2592); 87 | 88 | thisTransaction.tag = trytes.slice(2592, 2619); 89 | thisTransaction.attachmentTimestamp = Converter.value(transactionTrits.slice(7857, 7884)); 90 | thisTransaction.attachmentTimestampLowerBound = Converter.value(transactionTrits.slice(7884, 7911)); 91 | thisTransaction.attachmentTimestampUpperBound = Converter.value(transactionTrits.slice(7911, 7938)); 92 | thisTransaction.nonce = trytes.slice(2646, 2673); 93 | 94 | return thisTransaction; 95 | 96 | }, 97 | 98 | transactionTrytes: function(transaction) 99 | { 100 | var valueTrits = Converter.trits(transaction.value); 101 | while (valueTrits.length < 81) { 102 | valueTrits[valueTrits.length] = 0; 103 | } 104 | 105 | var timestampTrits = Converter.trits(transaction.timestamp); 106 | while (timestampTrits.length < 27) { 107 | timestampTrits[timestampTrits.length] = 0; 108 | } 109 | 110 | var currentIndexTrits = Converter.trits(transaction.currentIndex); 111 | while (currentIndexTrits.length < 27) { 112 | currentIndexTrits[currentIndexTrits.length] = 0; 113 | } 114 | 115 | var lastIndexTrits = Converter.trits(transaction.lastIndex); 116 | while (lastIndexTrits.length < 27) { 117 | lastIndexTrits[lastIndexTrits.length] = 0; 118 | } 119 | 120 | var attachmentTimestampTrits = Converter.trits(transaction.attachmentTimestamp || 0); 121 | while (attachmentTimestampTrits.length < 27) { 122 | attachmentTimestampTrits[attachmentTimestampTrits.length] = 0; 123 | } 124 | 125 | var attachmentTimestampLowerBoundTrits = Converter.trits(transaction.attachmentTimestampLowerBound || 0); 126 | while (attachmentTimestampLowerBoundTrits.length < 27) { 127 | attachmentTimestampLowerBoundTrits[attachmentTimestampLowerBoundTrits.length] = 0; 128 | } 129 | 130 | var attachmentTimestampUpperBoundTrits = Converter.trits(transaction.attachmentTimestampUpperBound || 0); 131 | while (attachmentTimestampUpperBoundTrits.length < 27) { 132 | attachmentTimestampUpperBoundTrits[attachmentTimestampUpperBoundTrits.length] = 0; 133 | } 134 | 135 | transaction.tag = transaction.tag || transaction.obsoleteTag; 136 | 137 | return transaction.signatureMessageFragment 138 | + transaction.address 139 | + Converter.trytes(valueTrits) 140 | + transaction.obsoleteTag 141 | + Converter.trytes(timestampTrits) 142 | + Converter.trytes(currentIndexTrits) 143 | + Converter.trytes(lastIndexTrits) 144 | + transaction.bundle 145 | + transaction.trunkTransaction 146 | + transaction.branchTransaction 147 | + transaction.tag 148 | + Converter.trytes(attachmentTimestampTrits) 149 | + Converter.trytes(attachmentTimestampLowerBoundTrits) 150 | + Converter.trytes(attachmentTimestampUpperBoundTrits) 151 | + transaction.nonce; 152 | } 153 | } 154 | 155 | }; 156 | 157 | module.exports = iotaTools; 158 | 159 | -------------------------------------------------------------------------------- /lib/iotaproxy.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /** 4 | * Simple proxy server for IOTA. 5 | * Intercepts attachToTangle commands and performs PoW locally. 6 | * 7 | * Author: Tim Samshuijzen 8 | * 9 | * References code copied from: 10 | * https://github.com/iotaledger/wallet 11 | * Licence: GNU General Public License v3.0 12 | */ 13 | 14 | const http = require('http'); 15 | const ccurlProvider = require('./ccurlprovider.js'); 16 | 17 | let iotaProxy = 18 | { 19 | host: '', 20 | port: 0, 21 | localPort: 0, 22 | overrideAttachToTangle: false, 23 | timeout: 0, 24 | running: false, 25 | server: null, 26 | 27 | start: function(options) 28 | { 29 | let opts = options || {}; 30 | this.host = (opts.host ? opts.host : 'iota.bitfinex.com').replace('http://', ''); 31 | this.port = (opts.port ? opts.port : 80); 32 | this.localPort = (opts.localPort ? opts.localPort : 14265); 33 | this.overrideAttachToTangle = (opts.overrideAttachToTangle ? true : false); 34 | this.timeout = (opts.timeout ? opts.timeout : 15); 35 | 36 | if (this.running) 37 | { 38 | this.stop(); 39 | } 40 | this.running = true; 41 | let that = this; 42 | 43 | if (this.overrideAttachToTangle) 44 | { 45 | ccurlProvider.init(); 46 | } 47 | 48 | this.server = http.createServer( 49 | function (request, response) 50 | { 51 | let requestbody = ''; 52 | request.on( 53 | 'data', 54 | function (data) 55 | { 56 | requestbody += data; 57 | if (requestbody.length > 1e6) 58 | { 59 | request.connection.destroy(); 60 | } 61 | } 62 | ); 63 | request.on( 64 | 'end', 65 | function () 66 | { 67 | let requestbodyOb = null; 68 | try 69 | { 70 | requestbodyOb = JSON.parse(requestbody); 71 | } 72 | catch (e) 73 | { 74 | requestbodyOb = null; 75 | } 76 | if (requestbodyOb !== null) 77 | { 78 | if ((that.overrideAttachToTangle) && (ccurlProvider.isOpen()) && (requestbodyOb.command === 'attachToTangle')) 79 | { 80 | console.log('Processing command ' + requestbodyOb.command); 81 | ccurlProvider.attachToTangle( 82 | requestbodyOb.trunkTransaction, requestbodyOb.branchTransaction, requestbodyOb.minWeightMagnitude, requestbodyOb.trytes, 83 | function(error, trytesArray) 84 | { 85 | if (error) 86 | { 87 | response.writeHead(500, 'Internal Server Error', {'Content-Type': 'text/plain'}); 88 | response.write('Error executing attachToTangle.\n'); 89 | response.end(); 90 | } 91 | else 92 | { 93 | response.writeHead(200, {'Content-Type': 'application/json'}); 94 | response.write(JSON.stringify({trytes: trytesArray}, null, 2)); 95 | response.end(); 96 | } 97 | } 98 | ); 99 | } 100 | else 101 | { 102 | console.log('Relaying command ' + requestbodyOb.command); 103 | let proxyRequestOptions = 104 | { 105 | hostname: that.host, 106 | port: that.port, 107 | path: request.url, 108 | method: request.method 109 | }; 110 | if (requestbody.length > 0) 111 | { 112 | proxyRequestOptions.headers = 113 | { 114 | 'Content-Type': request.headers['content-type'], 115 | 'Content-Length': requestbody.length 116 | }; 117 | // Make sure the x-iota-api-version header is also passed along, 118 | // no matter the casing used for this header. 119 | Object.keys(request.headers).forEach(function(key) 120 | { 121 | if (key.toLowerCase() === 'x-iota-api-version') 122 | { 123 | proxyRequestOptions.headers[key] = request.headers[key]; 124 | } 125 | }); 126 | } 127 | 128 | let proxyRequest = http.request( 129 | proxyRequestOptions, 130 | function (proxyResponse) 131 | { 132 | let proxyResult = ''; 133 | proxyResponse.on( 134 | 'data', 135 | function (data) 136 | { 137 | proxyResult += data; 138 | } 139 | ); 140 | proxyResponse.on( 141 | 'end', 142 | function() 143 | { 144 | response.writeHead(proxyResponse.statusCode, proxyResponse.statusMessage, {'Content-Type': proxyResponse.headers['content-type']}); 145 | response.write(proxyResult); 146 | response.end(); 147 | } 148 | ); 149 | } 150 | ); 151 | proxyRequest.on( 152 | 'error', 153 | function (err) 154 | { 155 | response.writeHead(404, 'Not Found', {'Content-Type': 'text/plain'}); 156 | response.write('Not Found'); 157 | response.end(); 158 | } 159 | ); 160 | proxyRequest.write(requestbody); 161 | proxyRequest.end(); 162 | } 163 | } 164 | else 165 | { 166 | response.writeHead(400, 'Bad Request', {'Content-Type': 'text/plain'}); 167 | response.write('error: invalid JSON\n'); 168 | response.end(); 169 | } 170 | } 171 | ); 172 | } 173 | ); 174 | this.server.setTimeout(this.timeout * 60 * 1000); // Default is 15 minutes timeout -> allow enough time for PoW. 175 | this.server.on( 176 | 'clientError', 177 | function(err, socket) 178 | { 179 | socket.end('HTTP/1.1 400 Bad Request\r\n\r\n'); 180 | } 181 | ); 182 | this.server.listen(this.localPort); 183 | console.log('IOTA proxy server started'); 184 | console.log('POW timeout is set to ' + this.timeout + ' min'); 185 | console.log('Listening on port ' + this.localPort); 186 | console.log('Relaying requests to ' + this.host + ':' + this.port); 187 | 188 | }, 189 | 190 | stop: function() 191 | { 192 | if (this.running) 193 | { 194 | this.running = false; 195 | ccurlProvider.close(); 196 | if (this.server !== null) 197 | { 198 | this.server.close( 199 | function() 200 | { 201 | } 202 | ); 203 | this.server = null; 204 | } 205 | } 206 | } 207 | }; 208 | 209 | module.exports = iotaProxy; 210 | -------------------------------------------------------------------------------- /lib/ccurlprovider.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /** 4 | * Curl library provider. 5 | * 6 | * Contains code copied from: 7 | * https://github.com/iotaledger/wallet 8 | * Licence: GNU General Public License v3.0 9 | */ 10 | 11 | const ffi = require('ffi'); 12 | const iotaTools = require('./iotatools.js'); 13 | const path = require("path"); 14 | 15 | const MAX_TIMESTAMP_VALUE = (Math.pow(3,27) - 1) / 2; 16 | 17 | let ccurlProvider = 18 | { 19 | libccurl: null, 20 | 21 | init: function() 22 | { 23 | this.close(); 24 | let libccurlPath = path.join(__dirname, 'libccurl'); 25 | let is64BitOS = false; 26 | if (process.platform === 'win32') 27 | { 28 | is64BitOS = ((process.arch === 'x64') || (process.env.PROCESSOR_ARCHITECTURE === 'AMD64') || process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432')); 29 | } 30 | else 31 | { 32 | is64BitOS = (process.arch === 'x64'); 33 | } 34 | if (process.platform === 'win32') 35 | { 36 | libccurlPath = path.join(libccurlPath, ('win' + (is64BitOS ? '64' : '32'))); 37 | } 38 | else if (process.platform == 'darwin') 39 | { 40 | libccurlPath = path.join(libccurlPath, 'mac'); 41 | } 42 | else 43 | { 44 | libccurlPath = path.join(libccurlPath, ('lin' + (is64BitOS ? '64' : '32'))); 45 | } 46 | libccurlPath = path.join(libccurlPath, 'libccurl'); 47 | 48 | try 49 | { 50 | this.libccurl = ffi.Library( 51 | libccurlPath, 52 | { 53 | ccurl_pow : ['string', ['string', 'int']], 54 | ccurl_pow_finalize : ['void', []], 55 | ccurl_pow_interrupt: ['void', []] 56 | } 57 | ); 58 | if ((!this.libccurl.hasOwnProperty("ccurl_pow")) || (!this.libccurl.hasOwnProperty("ccurl_pow_finalize")) || (!this.libccurl.hasOwnProperty("ccurl_pow_interrupt"))) 59 | { 60 | throw new Error("Could not load hashing library."); 61 | } 62 | } 63 | catch (err) 64 | { 65 | console.log(err.message ? err.message : err); 66 | this.libccurl = null; 67 | } 68 | return (this.libccurl !== null); 69 | }, 70 | 71 | isOpen: function() 72 | { 73 | return (this.libccurl !== null); 74 | }, 75 | 76 | close: function() 77 | { 78 | if (this.libccurl !== null) 79 | { 80 | /* 81 | try 82 | { 83 | if (this.libccurl && this.libccurl.hasOwnProperty("ccurl_pow_interrupt")) 84 | { 85 | this.libccurl.ccurl_pow_interrupt(); 86 | } 87 | if (this.libccurl && this.libccurl.hasOwnProperty("ccurl_pow_finalize")) 88 | { 89 | this.libccurl.ccurl_pow_finalize(); 90 | } 91 | } 92 | catch (err) 93 | { 94 | console.log(err.message ? err.message : err); 95 | } 96 | */ 97 | this.libccurl = null; 98 | } 99 | }, 100 | 101 | attachToTangle: function(trunkTransaction, branchTransaction, minWeightMagnitude, trytes, callback) 102 | { 103 | let that = this; 104 | if (this.libccurl !== null) 105 | { 106 | if (!this.libccurl.hasOwnProperty("ccurl_pow")) 107 | { 108 | return callback(new Error("Hashing not available")); 109 | } 110 | 111 | // inputValidator: Check if correct hash 112 | if (!iotaTools.valid.isHash(trunkTransaction)) 113 | { 114 | return callback(new Error("Invalid trunkTransaction")); 115 | } 116 | 117 | // inputValidator: Check if correct hash 118 | if (!iotaTools.valid.isHash(branchTransaction)) 119 | { 120 | return callback(new Error("Invalid branchTransaction")); 121 | } 122 | 123 | // inputValidator: Check if int 124 | if (!iotaTools.valid.isValue(minWeightMagnitude)) 125 | { 126 | return callback(new Error("Invalid minWeightMagnitude")); 127 | } 128 | 129 | let finalBundleTrytes = []; 130 | let previousTxHash = null; 131 | let trytesIndex = 0; 132 | 133 | let loopTrytes = function () 134 | { 135 | getBundleTrytes( 136 | trytes[trytesIndex], 137 | function(error) 138 | { 139 | if (error) 140 | { 141 | return callback(error); 142 | } 143 | else 144 | { 145 | trytesIndex++; 146 | if (trytesIndex < trytes.length) 147 | { 148 | loopTrytes(); 149 | } 150 | else 151 | { 152 | // reverse the order so that it's ascending from currentIndex 153 | return callback(null, finalBundleTrytes.reverse()); 154 | } 155 | } 156 | } 157 | ); 158 | }; 159 | 160 | let getBundleTrytes = function (thisTrytes, callback) 161 | { 162 | // PROCESS LOGIC: 163 | // Start with last index transaction 164 | // Assign it the trunk / branch which the user has supplied 165 | // IF there is a bundle, chain the bundle transactions via 166 | // trunkTransaction together 167 | 168 | var txObject = iotaTools.utils.transactionObject(thisTrytes); 169 | txObject.tag = txObject.obsoleteTag; 170 | txObject.attachmentTimestamp = Date.now(); 171 | txObject.attachmentTimestampLowerBound = 0; 172 | txObject.attachmentTimestampUpperBound = MAX_TIMESTAMP_VALUE; 173 | 174 | // If this is the first transaction, to be processed 175 | // Make sure that it's the last in the bundle and then 176 | // assign it the supplied trunk and branch transactions 177 | if (!previousTxHash) 178 | { 179 | // Check if last transaction in the bundle 180 | if (txObject.lastIndex !== txObject.currentIndex) 181 | { 182 | return callback(new Error("Wrong bundle order. The bundle should be ordered in descending order from currentIndex")); 183 | } 184 | txObject.trunkTransaction = trunkTransaction; 185 | txObject.branchTransaction = branchTransaction; 186 | } 187 | else 188 | { 189 | // Chain the bundle together via the trunkTransaction (previous tx in the bundle) 190 | // Assign the supplied trunkTransaciton as branchTransaction 191 | txObject.trunkTransaction = previousTxHash; 192 | txObject.branchTransaction = trunkTransaction; 193 | } 194 | 195 | var newTrytes = iotaTools.utils.transactionTrytes(txObject); 196 | 197 | // cCurl updates the nonce as well as the transaction hash 198 | that.libccurl.ccurl_pow.async( 199 | newTrytes, 200 | minWeightMagnitude, 201 | function(error, returnedTrytes) 202 | { 203 | if (error) 204 | { 205 | return callback(error); 206 | } 207 | else if (returnedTrytes == null) 208 | { 209 | return callback("Interrupted"); 210 | } 211 | 212 | let newTxObject= iotaTools.utils.transactionObject(returnedTrytes); 213 | 214 | // Assign the previousTxHash to this tx 215 | let txHash = newTxObject.hash; 216 | previousTxHash = txHash; 217 | 218 | finalBundleTrytes.push(returnedTrytes); 219 | 220 | return callback(null); 221 | } 222 | ); 223 | 224 | }; 225 | 226 | loopTrytes(); 227 | } 228 | } 229 | 230 | }; 231 | 232 | 233 | module.exports = ccurlProvider; 234 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------