Adding licensing information and bumping BotoCore minimum version to

LordAlfredo · LordAlfredo · commit ea4db3407c72 · 2019-06-26T15:56:31.000-07:00
match public launch
diff --git a/README.rst b/README.rst
@@ -0,0 +1,66 @@
+=============
+ec2-connect-cli
+=============
+
+This is a Python client for accessing EC2 instances via AWS EC2 Managed SSH.  This client generates a short-lived RSA
+keypair and pushes it through the AWS Managed SSH service, then uses the key to connect to the target EC2 instance.
+
+This client supports all standard ssh operations with the `mssh` command and all standard sftp operations with the
+`msftp` command.
+
+The ec2-connect-cli package works on Python versions:
+
+* 2.6.x and greater
+* 2.7.x and greater
+* 3.3.x and greater
+* 3.4.x and greater
+* 3.5.x and greater
+* 3.6.x and greater
+
+------------
+Installation
+------------
+
+The easiest way to install ec2-connect-cli is to use `pip`_::
+
+    $ pip install ec2instanceconnectcli
+
+or, if you are not installing in a ``virtualenv``::
+
+    $ sudo pip install ec2instanceconnectcli
+
+If you have the ec2-connect-cli installed and want to upgrade to the latest version you can run::
+
+    $ pip install --upgrade ec2instanceconnectcli
+
+This will install the ec2instanceconnectcli package as well as all dependencies.  Once you have the ec2instanceconnectcli
+directory structure on your workstation, you can just run::
+
+    $ cd <path_to_ec2instanceconnectcli>
+    $ python setup.py install
+
+---------------
+Getting Started
+---------------
+
+Before using ec2-connect-cli, you need to tell it about your AWS credentials.  This can be done in the same way
+as you would configure `aws-cli`_
+
+^^^^^^^^
+Examples
+^^^^^^^^
+
+Connect to an instance and open a shell
+
+    $ mssh [instance id]
+
+Connect to an instance by DNS name as user "my-user" and run the command "ls"
+
+    $ mssh my-user@ec2-[ec2 IP].us-east-1.compute.amazonaws.com -t [instance id] ls
+
+Run sftp against instance using the AWS CLI profile "otherprofile" and transferring my-file
+
+    $ msftp -pr otherprofile [instance id]:my-file
+
+.. _pip: http://www.pip-installer.org/en/latest/
+.. _aws-cli: https://github.com/aws/aws-cli
diff --git a/bin/msftp b/bin/msftp
@@ -1,4 +1,18 @@
 #!/usr/bin/env python
+
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import sys
 from ec2instanceconnectcli import mops
 
diff --git a/bin/mssh b/bin/mssh
@@ -1,4 +1,18 @@
 #!/usr/bin/env python
+
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import sys
 from ec2instanceconnectcli import mops
 
diff --git a/doc/README.rst b/doc/README.rst
@@ -0,0 +1,30 @@
+==========================
+Building The Documentation
+==========================
+
+**Note: This is not complete and currently only does basic doc generation.**
+
+Before building the documentation, make sure you have Python 2.7,
+the ec2instanceconnectcli, and all the necessary dependencies installed.  You can
+install dependencies by using the requirements-docs.txt file at the
+root of this repo::
+
+    pip install -r requirements-docs.txt
+
+The process for building the documentation is:
+
+* Run ``make html`` which will build all of the HTML documentation
+  into the ``build/html`` directory.
+
+* Run ``make man`` which will build all of the man pages into
+  ``../doc/man/man1``.  These files are included in the source
+  distribution and installed by ``python setup.py install``.
+
+* Run ``make text`` which will build all of the text pages that
+  are used for interactive help on the Windows platform.  These files
+  are included in the source distribution and installed by
+  ``python setup.py install``.
+
+You can perform all of these tasks by running ``make all`` in this
+directory.  If you have previously built the documentation and want
+to regenerate it, run ``make clean`` first.
diff --git a/ec2instanceconnectcli/EC2InstanceConnectCLI.py b/ec2instanceconnectcli/EC2InstanceConnectCLI.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import logging
 import sys
 import time
diff --git a/ec2instanceconnectcli/EC2InstanceConnectCommand.py b/ec2instanceconnectcli/EC2InstanceConnectCommand.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 class EC2InstanceConnectCommand(object):
     """
     Generates commands relevant for the client.
diff --git a/ec2instanceconnectcli/EC2InstanceConnectKey.py b/ec2instanceconnectcli/EC2InstanceConnectKey.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import os
 import tempfile
 
diff --git a/ec2instanceconnectcli/EC2InstanceConnectLogger.py b/ec2instanceconnectcli/EC2InstanceConnectLogger.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import logging
 
 class EC2InstanceConnectLogger(object):
diff --git a/ec2instanceconnectcli/__init__.py b/ec2instanceconnectcli/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"). You
 # may not use this file except in compliance with the License. A copy of
diff --git a/ec2instanceconnectcli/ec2_util.py b/ec2instanceconnectcli/ec2_util.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 from argparse import Namespace
 import sys
 
diff --git a/ec2instanceconnectcli/input_parser.py b/ec2instanceconnectcli/input_parser.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import re
 import socket
 
diff --git a/ec2instanceconnectcli/key_publisher.py b/ec2instanceconnectcli/key_publisher.py
@@ -1,5 +1,17 @@
-import sys
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
 
+import sys
 
 def push_public_key(session, instance_id, user, pub_key, target_zone):
     """
diff --git a/ec2instanceconnectcli/key_utils.py b/ec2instanceconnectcli/key_utils.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 from cryptography.hazmat.backends import default_backend as crypto_default_backend
 from cryptography.hazmat.primitives import serialization as crypto_serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
diff --git a/ec2instanceconnectcli/mops.py b/ec2instanceconnectcli/mops.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import sys
 import argparse
 
diff --git a/ec2instanceconnectcli/mputty.py b/ec2instanceconnectcli/mputty.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import argparse
 import sys
 
diff --git a/ec2instanceconnectcli/py2py3.py b/ec2instanceconnectcli/py2py3.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import sys
 
 __all__ = ['PY2', 'input', 'StringIO', 'BytesIO', 'ConfigParser', 'u']
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 setuptools>=3.3
 cryptography>=1.9
-botocore>=1.8.0
+botocore>=1.12.178
 pytest>=3.2.3
 pytest-cov>=2.5.1
diff --git a/tests/test_EC2ConnectCLI.py b/tests/test_EC2ConnectCLI.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 from ec2instanceconnectcli.EC2InstanceConnectCLI import EC2InstanceConnectCLI
 from ec2instanceconnectcli.EC2InstanceConnectCommand import EC2InstanceConnectCommand
 from ec2instanceconnectcli.EC2InstanceConnectLogger import EC2InstanceConnectLogger
diff --git a/tests/test_ec2_util.py b/tests/test_ec2_util.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 from unittest import mock
 from testloader.test_base import TestBase
 from ec2instanceconnectcli import ec2_util
diff --git a/tests/test_input_parser.py b/tests/test_input_parser.py
@@ -1,3 +1,16 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 import argparse
 import getpass
 from ec2instanceconnectcli import input_parser
diff --git a/tests/test_key_publisher.py b/tests/test_key_publisher.py
diff --git a/tests/test_key_utils.py b/tests/test_key_utils.py
diff --git a/tests/testloader/test_base.py b/tests/testloader/test_base.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.`
	`1`	`+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License"). You`
`4`	`4`	`# may not use this file except in compliance with the License. A copy of`