-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
260 changed files
with
45,878 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contributing to esptool.py | ||
|
||
## Reporting Issues | ||
|
||
Please report bugs in esptool.py if you find them. | ||
|
||
However, before reporting a bug please check through the following: | ||
|
||
* [Troubleshooting Section](https://github.com/espressif/esptool/#troubleshooting) - common problems and known issues | ||
|
||
* [Existing Open Issues](https://github.com/espressif/esptool/issues) - someone might have already encountered this. | ||
|
||
If you don't find anything, please [open a new issue](https://github.com/espressif/esptool/issues/new). | ||
|
||
## Sending Feature Requests | ||
|
||
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful. | ||
|
||
There are usually some outstanding feature requests in the [existing issues list](https://github.com/espressif/esptool/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. | ||
|
||
## Sending Pull Requests | ||
|
||
Pull Requests with changes and fixes are also welcome! | ||
|
||
### Code Style & Static Analysis | ||
|
||
esptool.py complies with Flake 8 and is valid Python 2 & Python 3 code (in the same source file.) | ||
|
||
When you submit a Pull Request, the Travis automated build system will run automated checks for this, using the [flake8 tool](http://flake8.readthedocs.io/en/latest/). If you want to check your code locally before submitting, you can install flake8 and run `python setup.py flake8` to test it. | ||
|
||
### Automated Integration Tests | ||
|
||
The test directory contains an integration suite with some integration tests for esptool.py: | ||
|
||
* `test_imagegen.py` tests the elf2image command and is run automatically by Travis for each Pull Request. You can run this command locally to check for regressions in the elf2image functionality. | ||
|
||
* `test_esptool.py` is a [Python unittest](https://docs.python.org/3/library/unittest.html) file that contains integration tests to be run against real ESP8266 or ESP32 hardware. These tests need real hardware so are not run automatically by Travis, they need to be run locally: | ||
|
||
`test_esptool.py` takes a command line with the following format: | ||
|
||
`./test_esptool.py <serial port> <name of chip> <baud rate> [optional test name(s)]` | ||
|
||
For example, to run all tests on an ESP32 board connected to /dev/ttyUSB0, at 230400bps: | ||
|
||
`./test_esptool.py /dev/ttyUSB0 esp32 230400` | ||
|
||
Or to run the TestFlashing suite only on an ESP8266 board connected to /dev/ttyUSB2` at 460800bps: | ||
|
||
`./test_esptool.py /dev/ttyUSB2 esp8266 460800 TestFlashing` | ||
|
||
(Note that some tests will fail at higher baud rates on some hardware.) |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
include README.md | ||
include LICENSE | ||
# sdist includes test/test*.py by default, but esptool.py tests | ||
# are so far only intended to run from the git repo itself | ||
prune test | ||
prune ecdsa | ||
prune pyaes | ||
prune flasher_stub | ||
prune .github | ||
exclude .git* | ||
exclude .travis* | ||
exclude MANIFEST* | ||
|
||
|
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
__all__ = ["curves", "der", "ecdsa", "ellipticcurve", "keys", "numbertheory", | ||
"test_pyecdsa", "util", "six"] | ||
from .keys import SigningKey, VerifyingKey, BadSignatureError, BadDigestError | ||
from .curves import NIST192p, NIST224p, NIST256p, NIST384p, NIST521p, SECP256k1 | ||
|
||
_hush_pyflakes = [SigningKey, VerifyingKey, BadSignatureError, BadDigestError, | ||
NIST192p, NIST224p, NIST256p, NIST384p, NIST521p, SECP256k1] | ||
del _hush_pyflakes | ||
|
||
# This code comes from http://github.com/warner/python-ecdsa | ||
|
||
from ._version import get_versions | ||
__version__ = get_versions()['version'] | ||
del get_versions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,183 @@ | ||
|
||
# This file helps to compute a version number in source trees obtained from | ||
# git-archive tarball (such as those provided by githubs download-from-tag | ||
# feature). Distribution tarballs (built by setup.py sdist) and build | ||
# directories (produced by setup.py build) will contain a much shorter file | ||
# that just contains the computed version number. | ||
|
||
# This file is released into the public domain. Generated by | ||
# versioneer-0.12 (https://github.com/warner/python-versioneer) | ||
|
||
# these strings will be replaced by git during git-archive | ||
git_refnames = " (tag: python-ecdsa-0.13)" | ||
git_full = "5a6fc047222cf21ad89f6cbf8782d0f1e3ddacda" | ||
|
||
# these strings are filled in when 'setup.py versioneer' creates _version.py | ||
tag_prefix = "python-ecdsa-" | ||
parentdir_prefix = "ecdsa-" | ||
versionfile_source = "ecdsa/_version.py" | ||
|
||
import os, sys, re, subprocess, errno | ||
|
||
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): | ||
assert isinstance(commands, list) | ||
p = None | ||
for c in commands: | ||
try: | ||
# remember shell=False, so use git.cmd on windows, not just git | ||
p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, | ||
stderr=(subprocess.PIPE if hide_stderr | ||
else None)) | ||
break | ||
except EnvironmentError: | ||
e = sys.exc_info()[1] | ||
if e.errno == errno.ENOENT: | ||
continue | ||
if verbose: | ||
print("unable to run %s" % args[0]) | ||
print(e) | ||
return None | ||
else: | ||
if verbose: | ||
print("unable to find command, tried %s" % (commands,)) | ||
return None | ||
stdout = p.communicate()[0].strip() | ||
if sys.version >= '3': | ||
stdout = stdout.decode() | ||
if p.returncode != 0: | ||
if verbose: | ||
print("unable to run %s (error)" % args[0]) | ||
return None | ||
return stdout | ||
|
||
|
||
def versions_from_parentdir(parentdir_prefix, root, verbose=False): | ||
# Source tarballs conventionally unpack into a directory that includes | ||
# both the project name and a version string. | ||
dirname = os.path.basename(root) | ||
if not dirname.startswith(parentdir_prefix): | ||
if verbose: | ||
print("guessing rootdir is '%s', but '%s' doesn't start with prefix '%s'" % | ||
(root, dirname, parentdir_prefix)) | ||
return None | ||
return {"version": dirname[len(parentdir_prefix):], "full": ""} | ||
|
||
def git_get_keywords(versionfile_abs): | ||
# the code embedded in _version.py can just fetch the value of these | ||
# keywords. When used from setup.py, we don't want to import _version.py, | ||
# so we do it with a regexp instead. This function is not used from | ||
# _version.py. | ||
keywords = {} | ||
try: | ||
f = open(versionfile_abs,"r") | ||
for line in f.readlines(): | ||
if line.strip().startswith("git_refnames ="): | ||
mo = re.search(r'=\s*"(.*)"', line) | ||
if mo: | ||
keywords["refnames"] = mo.group(1) | ||
if line.strip().startswith("git_full ="): | ||
mo = re.search(r'=\s*"(.*)"', line) | ||
if mo: | ||
keywords["full"] = mo.group(1) | ||
f.close() | ||
except EnvironmentError: | ||
pass | ||
return keywords | ||
|
||
def git_versions_from_keywords(keywords, tag_prefix, verbose=False): | ||
if not keywords: | ||
return {} # keyword-finding function failed to find keywords | ||
refnames = keywords["refnames"].strip() | ||
if refnames.startswith("$Format"): | ||
if verbose: | ||
print("keywords are unexpanded, not using") | ||
return {} # unexpanded, so not in an unpacked git-archive tarball | ||
refs = set([r.strip() for r in refnames.strip("()").split(",")]) | ||
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of | ||
# just "foo-1.0". If we see a "tag: " prefix, prefer those. | ||
TAG = "tag: " | ||
tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) | ||
if not tags: | ||
# Either we're using git < 1.8.3, or there really are no tags. We use | ||
# a heuristic: assume all version tags have a digit. The old git %d | ||
# expansion behaves like git log --decorate=short and strips out the | ||
# refs/heads/ and refs/tags/ prefixes that would let us distinguish | ||
# between branches and tags. By ignoring refnames without digits, we | ||
# filter out many common branch names like "release" and | ||
# "stabilization", as well as "HEAD" and "master". | ||
tags = set([r for r in refs if re.search(r'\d', r)]) | ||
if verbose: | ||
print("discarding '%s', no digits" % ",".join(refs-tags)) | ||
if verbose: | ||
print("likely tags: %s" % ",".join(sorted(tags))) | ||
for ref in sorted(tags): | ||
# sorting will prefer e.g. "2.0" over "2.0rc1" | ||
if ref.startswith(tag_prefix): | ||
r = ref[len(tag_prefix):] | ||
if verbose: | ||
print("picking %s" % r) | ||
return { "version": r, | ||
"full": keywords["full"].strip() } | ||
# no suitable tags, so we use the full revision id | ||
if verbose: | ||
print("no suitable tags, using full revision id") | ||
return { "version": keywords["full"].strip(), | ||
"full": keywords["full"].strip() } | ||
|
||
|
||
def git_versions_from_vcs(tag_prefix, root, verbose=False): | ||
# this runs 'git' from the root of the source tree. This only gets called | ||
# if the git-archive 'subst' keywords were *not* expanded, and | ||
# _version.py hasn't already been rewritten with a short version string, | ||
# meaning we're inside a checked out source tree. | ||
|
||
if not os.path.exists(os.path.join(root, ".git")): | ||
if verbose: | ||
print("no .git in %s" % root) | ||
return {} | ||
|
||
GITS = ["git"] | ||
if sys.platform == "win32": | ||
GITS = ["git.cmd", "git.exe"] | ||
stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"], | ||
cwd=root) | ||
if stdout is None: | ||
return {} | ||
if not stdout.startswith(tag_prefix): | ||
if verbose: | ||
print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix)) | ||
return {} | ||
tag = stdout[len(tag_prefix):] | ||
stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) | ||
if stdout is None: | ||
return {} | ||
full = stdout.strip() | ||
if tag.endswith("-dirty"): | ||
full += "-dirty" | ||
return {"version": tag, "full": full} | ||
|
||
|
||
def get_versions(default={"version": "unknown", "full": ""}, verbose=False): | ||
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have | ||
# __file__, we can work backwards from there to the root. Some | ||
# py2exe/bbfreeze/non-CPython implementations don't do __file__, in which | ||
# case we can only use expanded keywords. | ||
|
||
keywords = { "refnames": git_refnames, "full": git_full } | ||
ver = git_versions_from_keywords(keywords, tag_prefix, verbose) | ||
if ver: | ||
return ver | ||
|
||
try: | ||
root = os.path.abspath(__file__) | ||
# versionfile_source is the relative path from the top of the source | ||
# tree (where the .git directory might live) to this file. Invert | ||
# this to find the root from __file__. | ||
for i in range(len(versionfile_source.split(os.sep))): | ||
root = os.path.dirname(root) | ||
except NameError: | ||
return default | ||
|
||
return (git_versions_from_vcs(tag_prefix, root, verbose) | ||
or versions_from_parentdir(parentdir_prefix, root, verbose) | ||
or default) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
from __future__ import division | ||
|
||
from . import der, ecdsa | ||
|
||
class UnknownCurveError(Exception): | ||
pass | ||
|
||
def orderlen(order): | ||
return (1+len("%x"%order))//2 # bytes | ||
|
||
# the NIST curves | ||
class Curve: | ||
def __init__(self, name, curve, generator, oid, openssl_name=None): | ||
self.name = name | ||
self.openssl_name = openssl_name # maybe None | ||
self.curve = curve | ||
self.generator = generator | ||
self.order = generator.order() | ||
self.baselen = orderlen(self.order) | ||
self.verifying_key_length = 2*self.baselen | ||
self.signature_length = 2*self.baselen | ||
self.oid = oid | ||
self.encoded_oid = der.encode_oid(*oid) | ||
|
||
NIST192p = Curve("NIST192p", ecdsa.curve_192, ecdsa.generator_192, | ||
(1, 2, 840, 10045, 3, 1, 1), "prime192v1") | ||
NIST224p = Curve("NIST224p", ecdsa.curve_224, ecdsa.generator_224, | ||
(1, 3, 132, 0, 33), "secp224r1") | ||
NIST256p = Curve("NIST256p", ecdsa.curve_256, ecdsa.generator_256, | ||
(1, 2, 840, 10045, 3, 1, 7), "prime256v1") | ||
NIST384p = Curve("NIST384p", ecdsa.curve_384, ecdsa.generator_384, | ||
(1, 3, 132, 0, 34), "secp384r1") | ||
NIST521p = Curve("NIST521p", ecdsa.curve_521, ecdsa.generator_521, | ||
(1, 3, 132, 0, 35), "secp521r1") | ||
SECP256k1 = Curve("SECP256k1", ecdsa.curve_secp256k1, ecdsa.generator_secp256k1, | ||
(1, 3, 132, 0, 10), "secp256k1") | ||
|
||
curves = [NIST192p, NIST224p, NIST256p, NIST384p, NIST521p, SECP256k1] | ||
|
||
def find_curve(oid_curve): | ||
for c in curves: | ||
if c.oid == oid_curve: | ||
return c | ||
raise UnknownCurveError("I don't know about the curve with oid %s." | ||
"I only know about these: %s" % | ||
(oid_curve, [c.name for c in curves])) |
Oops, something went wrong.