{ "info": { "author": "Peter Todd", "author_email": "pete@petertodd.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)", "Programming Language :: Python :: 3 :: Only", "Topic :: Security :: Cryptography" ], "description": "# OpenTimestamps Client\n\nCommand-line tool to create and validate timestamp proofs with the\nOpenTimestamps protocol, using the Bitcoin blockchain as a timestamp notary.\nAdditionally this package provides timestamping of PGP signed Git commits, and\nverification of timestamps for both Git commits as a whole, and individual\nfiles within a Git repository.\n\n## Requirements\n\n* Python3\n\nWhile OpenTimestamps can *create* timestamps without a local Bitcoin node, to\n*verify* timestamps you need a local Bitcoin Core node (a pruned node is fine).\n\n\n## Installation\n\nEither via PyPi:\n\n $ pip3 install opentimestamps-client\n\nor from source:\n\n $ python3 setup.py install\n\nOn Debian (Stretch) you can install the necessary system dependencies with:\n\n sudo apt-get install python3 python3-dev python3-pip python3-setuptools python3-wheel\n\n## Usage\n\nCreating a timestamp:\n\n $ ots stamp README.md\n Submitting to remote calendar https://a.pool.opentimestamps.org\n Submitting to remote calendar https://b.pool.opentimestamps.org\n Submitting to remote calendar https://a.pool.eternitywall.com\n\nYou'll see that `README.md.ots` has been created with the aid of three remote\ncalendars. We can't verify it immediately however:\n\n $ ots verify README.md.ots\n Assuming target filename is 'README.md'\n Calendar https://alice.btc.calendar.opentimestamps.org: Pending confirmation in Bitcoin blockchain\n Calendar https://bob.btc.calendar.opentimestamps.org: Pending confirmation in Bitcoin blockchain\n Calendar https://finney.calendar.eternitywall.com: Pending confirmation in Bitcoin blockchain\n\nIt takes a few hours for the timestamp to get confirmed by the Bitcoin\nblockchain; we're not doing one transaction per timestamp.\n\nHowever, the client does come with a number of example timestamps which you can\ntry verifying immediately. Here's a complete timestamp that can be verified\nlocally:\n\n $ ots verify examples/hello-world.txt.ots\n Assuming target filename is 'examples/hello-world.txt'\n Success! Bitcoin block 358391 attests existence as of 2015-05-28 CEST\n\nYou can specify JSON-RPC credentials (`USER` and `PASS`) for a local bitcoin node like so:\n\n $ ots --bitcoin-node http://USER:PASS@127.0.0.1:8332/ verify examples/hello-world.txt.ots\n Assuming target filename is 'examples/hello-world.txt'\n Success! Bitcoin block 358391 attests existence as of 2015-05-28 CEST\n\nIncomplete timestamps are ones that require the assistance of a remote calendar\nto verify; the calendar provides the path to the Bitcoin block header:\n\n $ ots verify examples/incomplete.txt.ots\n Assuming target filename is 'examples/incomplete.txt'\n Got 1 new attestation(s) from https://alice.btc.calendar.opentimestamps.org\n Success! Bitcoin block 428648 attests existence as of 2016-09-07 CEST\n\nThe client maintains a cache of timestamps it obtains from remote calendars, so\nif you verify the same file again it'll use the cache:\n\n $ ots verify examples/incomplete.txt.ots\n Assuming target filename is 'examples/incomplete.txt'\n Got 1 attestation(s) from cache\n Success! Bitcoin block 428648 attests existence as of 2016-09-07 CEST\n\nYou can also upgrade an incomplete timestamp, which adds the path to the\nBitcoin blockchain to the timestamp itself:\n\n $ ots upgrade examples/incomplete.txt.ots\n Got 1 attestation(s) from cache\n Success! Timestamp is complete\n\nFinally, you can get information on a timestamp, including the actual\ncommitment operations and attestations in it:\n\n $ ots info examples/two-calendars.txt.ots\n File sha256 hash: efaa174f68e59705757460f4f7d204bd2b535cfd194d9d945418732129404ddb\n Timestamp:\n append 839037eef449dec6dac322ca97347c45\n sha256\n -> append 6b4023b6edd3a0eeeb09e5d718723b9e\n sha256\n prepend 57d46515\n append eadd66b1688d5574\n verify PendingAttestation('https://alice.btc.calendar.opentimestamps.org')\n -> append a3ad701ef9f10535a84968b5a99d8580\n sha256\n prepend 57d46516\n append 647b90ea1b270a97\n verify PendingAttestation('https://bob.btc.calendar.opentimestamps.org')\n\n### Timestamping and Verifying PGP Signed Git Commits\n\nSee `doc/git-integration.md`\n\n\n## Privacy Security\n\nTimestamping inherently records potentially revealing metadata: the current\ntime. If you create multiple timestamps in close succession it's quite likely\nthat an adversary will be able to link those timestamps as related simply on\nthe basis of when they were created; if you make use of the timestamp multiple\nfiles in one command functionality (`./ots stamp ... `)\nmost of the commitment operations in the timestamps themselves will be\nidentical, providing an adversary very strong evidence that the files were\ntimestamped by the same person. Finally, the REST API used to communicate with\nremote calendars doesn't currently attempt to provide any privacy, although it\ncould be modified to do so in the future (e.g. with prefix filters).\n\nFile contents *are* protected with nonces: a remote calendar learns nothing\nabout the contents of anything you timestamp as it only ever receives an opaque\nand meaningless digest. Equally, if multiple files are timestamped at once,\neach file is protected by an individual nonce; the timestamp for one file\nreveals nothing about the contents of another file timestamped at the same\ntime.\n\n## Compatibility Expectations\n\nOpenTimestamps is alpha software, so it's possible that timestamp formats may\nhave to change in the future in non-backward-compatible ways. However it will\nalmost certainly be possible to write conversion tools for any\nnon-backwards-compatible changes.\n\nIt's very likely that the REST protocol used to communicate with remote\ncalendars will change, including in backwards incompatible ways. If this\nhappens you'll just need to upgrade your client; existing timestamps will be\nunaffected.\n\n## Calendar Mirroring\n\nAs a short-term measure, the raw calendar data for the three calendar servers\nin operation at this time can be downloaded directly. See\nthe `contrib/calendar-mirror.sh` script for details.\n\n## Development\n\nUse the setuptools development mode:\n\n python3 setup.py develop --user\n\n\n## Known Issues\n\n* Need unit tests for the client.\n\n* Git tree re-hashing support fails on certain filenames with invalid unicode\n encodings; this appears to be due to bugs in the underlying GitPython\n library. As a work-around, you may find the `convmv` tool useful to find and\n rename these files.\n\n* Git annex support only works with the SHA256 and SHA256E backends.\n\n* Errors in the Bitcoin RPC communication aren't handled in a user-friendly\n way.\n\n* Not all Python platforms check SSL certificates correctly. This means that on\n some platforms, it would be possible for a MITM attacker to intercept HTTPS\n connections to remote calendars. That said, it shouldn't be possible for such\n an attacker to do anything worse than give us a timestamp that fails\n validation, an easily fixed problem.\n\n* ots-git-gpg-wrapper doesn't yet check for you if the timestamp on the git commit\n makes sense.\n\n* `bitcoin` package can cause issues, with ots confusing it with the\n required `python-bitcoinlib` package. A symptom of this issue is the\n message `AttributeError: module 'bitcoin' has no attribute\n 'SelectParams'` or `JSONDecodeError(\"Expecting value\", s, err.value) from None`. To remedy this issue, one must do the following:\n\n```bash\n# uninstall the packages through pip\npip3 uninstall bitcoin python-bitcoinlib\n\n# remove the bitcoin directory manually from your dist-packages folder\nrm -rf /usr/local/lib/python3.5/dist-packages/bitcoin\n\n# reinstall the required package\npip3 install python-bitcoinlib\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/opentimestamps/opentimestamps-client", "keywords": "cryptography timestamping bitcoin", "license": "LGPL3", "maintainer": "", "maintainer_email": "", "name": "opentimestamps-client", "package_url": "https://pypi.org/project/opentimestamps-client/", "platform": "", "project_url": "https://pypi.org/project/opentimestamps-client/", "project_urls": { "Homepage": "https://github.com/opentimestamps/opentimestamps-client" }, "release_url": "https://pypi.org/project/opentimestamps-client/0.7.0/", "requires_dist": [ "GitPython (>=2.0.8)", "PySocks (>=1.5.0)", "appdirs (>=1.3.0)", "opentimestamps (<0.5.0,>=0.4.0)" ], "requires_python": "", "summary": "Command-line tool to create and verify OpenTimestamps proofs", "version": "0.7.0" }, "last_serial": 5707099, "releases": { "0.5.0": [ { "comment_text": "", "digests": { "md5": "0517e528187c76f2ab365cdd458f6764", "sha256": "915233a36e1a86acc3a17736318946b674070ffb9c66106bba745a0e78d3ef88" }, "downloads": -1, "filename": "opentimestamps_client-0.5.0-py3-none-any.whl", "has_sig": true, "md5_digest": "0517e528187c76f2ab365cdd458f6764", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 24905, "upload_time": "2017-08-26T01:26:41", "url": "https://files.pythonhosted.org/packages/bc/6b/d77bfcd300abda2aeadedcb96a8d2ed37217363b78c3a8879e6bc6ff48df/opentimestamps_client-0.5.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "919af8705841658aa26075e4c97fdd38", "sha256": "4931548d697d1555fc2c14ba54a1456225dde003b22afbc2dfeab981f26ee838" }, "downloads": -1, "filename": "opentimestamps-client-0.5.0.tar.gz", "has_sig": true, "md5_digest": "919af8705841658aa26075e4c97fdd38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17469, "upload_time": "2017-08-26T01:26:34", "url": "https://files.pythonhosted.org/packages/25/90/6f05e89cc438bbfa7622aa81654a839953774dd1ef3ad18ef0d32f1585a0/opentimestamps-client-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "c8d6514f3a81fac8220ab790fff982c1", "sha256": "5e400f997dcb01635105a47e556efe96f7406157d1711ceae6eca763c79d7ebe" }, "downloads": -1, "filename": "opentimestamps_client-0.5.1-py3-none-any.whl", "has_sig": true, "md5_digest": "c8d6514f3a81fac8220ab790fff982c1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 24919, "upload_time": "2017-12-11T22:00:21", "url": "https://files.pythonhosted.org/packages/96/65/17187f8b088ebf6bad4ea6d085916bcd1cdecaa12cdcede322b75d2b9613/opentimestamps_client-0.5.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3ca464a0996a0971745d9cdf5f74b93e", "sha256": "4afce47ebaf141a21f08f8c180fc5cb99be04ab72013b87a2b5c7d655d818cdd" }, "downloads": -1, "filename": "opentimestamps-client-0.5.1.tar.gz", "has_sig": true, "md5_digest": "3ca464a0996a0971745d9cdf5f74b93e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17471, "upload_time": "2017-12-11T22:00:22", "url": "https://files.pythonhosted.org/packages/fe/14/c0def69b4d4905def8252e8efeebe768b6b6c9e345a6a42e7e18f971dafd/opentimestamps-client-0.5.1.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "4bf511ba10c871e5f751848cf801ef80", "sha256": "42bc2e58171a46a6047800c8fe7ee92a98ae997b8196445d61f6305347fec21c" }, "downloads": -1, "filename": "opentimestamps_client-0.6.0-py3-none-any.whl", "has_sig": true, "md5_digest": "4bf511ba10c871e5f751848cf801ef80", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 25530, "upload_time": "2018-04-13T17:16:13", "url": "https://files.pythonhosted.org/packages/c4/68/c63163181d1c8c43d737b768620df6c2e8d3b1d0870522f7a2d6fc726b09/opentimestamps_client-0.6.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "181c7d5d73bea1286eef5d868e406b35", "sha256": "c1d9dab1c4052519c97e3512ef4fd48f87a640e41ba2d0099b23bc521f460a49" }, "downloads": -1, "filename": "opentimestamps-client-0.6.0.tar.gz", "has_sig": true, "md5_digest": "181c7d5d73bea1286eef5d868e406b35", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20638, "upload_time": "2018-04-13T17:16:14", "url": "https://files.pythonhosted.org/packages/52/33/0c3e56fb18b32e86c8f6207f600104d7cee122f9c4dc1201124c113989ff/opentimestamps-client-0.6.0.tar.gz" } ], "0.7.0": [ { "comment_text": "", "digests": { "md5": "2c55611fe57f205bf635f97368eae440", "sha256": "541a624056ed544d60b9f3552189fd3bf76f8322b8e7a387b2a4179c158cc81d" }, "downloads": -1, "filename": "opentimestamps_client-0.7.0-py3-none-any.whl", "has_sig": true, "md5_digest": "2c55611fe57f205bf635f97368eae440", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 27278, "upload_time": "2019-08-21T05:31:23", "url": "https://files.pythonhosted.org/packages/98/ae/5a4aa29e753d112c69eb3ec2088e5eefc9ded6128c77b274284631bf9b78/opentimestamps_client-0.7.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4b821ed6acb2d13dd12f28683e1a4160", "sha256": "e9de235029242e34d739df3f9b1e0c9ef6bf045162434bd89b7b128d97332ddf" }, "downloads": -1, "filename": "opentimestamps-client-0.7.0.tar.gz", "has_sig": true, "md5_digest": "4b821ed6acb2d13dd12f28683e1a4160", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21294, "upload_time": "2019-08-21T05:31:24", "url": "https://files.pythonhosted.org/packages/cc/f4/df04e612dc13824b49a8b16ecd23dfc08486c00083bfa8f25fe73611dad4/opentimestamps-client-0.7.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2c55611fe57f205bf635f97368eae440", "sha256": "541a624056ed544d60b9f3552189fd3bf76f8322b8e7a387b2a4179c158cc81d" }, "downloads": -1, "filename": "opentimestamps_client-0.7.0-py3-none-any.whl", "has_sig": true, "md5_digest": "2c55611fe57f205bf635f97368eae440", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 27278, "upload_time": "2019-08-21T05:31:23", "url": "https://files.pythonhosted.org/packages/98/ae/5a4aa29e753d112c69eb3ec2088e5eefc9ded6128c77b274284631bf9b78/opentimestamps_client-0.7.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4b821ed6acb2d13dd12f28683e1a4160", "sha256": "e9de235029242e34d739df3f9b1e0c9ef6bf045162434bd89b7b128d97332ddf" }, "downloads": -1, "filename": "opentimestamps-client-0.7.0.tar.gz", "has_sig": true, "md5_digest": "4b821ed6acb2d13dd12f28683e1a4160", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21294, "upload_time": "2019-08-21T05:31:24", "url": "https://files.pythonhosted.org/packages/cc/f4/df04e612dc13824b49a8b16ecd23dfc08486c00083bfa8f25fe73611dad4/opentimestamps-client-0.7.0.tar.gz" } ] }