Skip to content

Commit

Permalink
fix: Remove AWS IAM auth leftovers
Browse files Browse the repository at this point in the history
As a follow-up for #1203, any reference to AWS access/secret key, and
role ARN is being removed.
  • Loading branch information
adamantike committed Nov 15, 2023
1 parent e523c68 commit e696981
Show file tree
Hide file tree
Showing 10 changed files with 2 additions and 135 deletions.
4 changes: 0 additions & 4 deletions credentials.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,3 @@ default:
refresh_token: ''
lwa_app_id: ''
lwa_client_secret: ''
aws_secret_key: ''
aws_access_key: ''
role_arn: ''

5 changes: 0 additions & 5 deletions docs/config_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ If you're only using one account, place it under default. You can pass the accou
Orders(refresh_token='...')
.. warning::
If you have assigned the execute-api (STS) permissions to your AWS **user**, omit `role_arn`.
If you have assigned the permission to a role, the `role_arn` parameter is required.
.. code-block:: yaml
version: '1.0'
Expand Down
6 changes: 0 additions & 6 deletions docs/env_variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,6 @@ LWA_CLIENT_SECRET Your login with amazon client secret
Orders(refresh_token='...')
.. warning::
If you have assigned the execute-api (STS) permissions to your AWS **user**, omit `role_arn`.

If you have assigned the permissions to a role, the `role_arn` parameter is required.


To set environment variables under linux/mac, use

.. code-block:: bash
Expand Down
40 changes: 1 addition & 39 deletions docs/examples/authorisation_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,11 @@ Internal Seller Access
To gain initial access to the Api you will need to follow the authorisation process as documented by
Amazon https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md

This involves three main stages:
This involves two main stages:

- Configuring AWS IAM to have User, Role and Permissions for SPAPI
- Adding an App to your Seller Central account.
- Configuring Python-SPAPI with the correct credentials.

Configuring AWS IAM:
^^^^^^^^^^^^^^^^^^^^

1. Create an IAM User
2. Create an IAM Policy
3. Create an IAM Role
4. Add an AWS Security Token Service (STS) policy to the IAM User

.. note::
This guide assumes you have used the ROLE for attaching the permissions policy to as per the SPAPI quick start guide from Amazon

Make sure you take note of the following items before progressing to the App setup in Seller Central:

- User ARN
- Role ARN
- AWS Access Key
- AWS Secret Key

There is the option to download the `new user credentials` - this will give you a CSV file of the `Access Key` and `Secret Key`

.. warning::
You will only get one chance to view the Secret key

Configuring the App in Seller Central:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -48,9 +24,6 @@ Overview:

- Seller Central -> Partner Network -> Develop Apps.
- Add a new client app
- Add in the IAM *ROLE* that you attached the execute permissions to.
- Select the necessary permissions for your app.
- The OAUTH details are not required (for self certification apps)
- Click the `LWA Credentials View` link to see your `Login With Amazon` credentials.
- Click *Authorise* and copy the `REFRESH_TOKEN` that is provided to you. *This is your only chance to see this token!, you will nee to regenerate it if you lose it.*

Expand All @@ -65,29 +38,18 @@ The following is an overview of which credentials go with which key.
- `refresh_token` -> This is from Seller Central, Authorisation of the app window
- `lws_app_id` -> This is from Seller central under LWA client credentials -> Client Identifier and will look like `amzn1.application-oa2-client.7b18cd......`
- `lwa_client_secret` -> This is from Seller central under LWA client credentials -> Client Secret and will look like `b5f7f8...`
- `aws_access_key` -> From AWS IAM Setup (Downloaded in the `new_user_credentials.csv`) and is called `Access key ID`
- `aws_secret_key` -> From AWS IAM Setup (Downloaded in the `new_user_credentials.csv`) and is called `Secret access key`
- `role_arn` is from the AWS IAM Setup and is the ARN of the ROLE and will look like `arn:aws:iam::1234567890:role/SellingPartnerAPIRole`

.. code-block:: python
credentials = dict(
refresh_token='your_refresh_token', # From Seller central under Authorise -> Refresh Token
lwa_app_id='your_lwa_app_id', # From Seller Central, named CLIENT IDENTIFIER on website.
lwa_client_secret='your_lwa_client_secret', # From Seller Central, named CLIENT SECRET on website.
aws_access_key='your_aws_access_key', # From AWS IAM Setup
aws_secret_key='your_aws_secret_key', # From AWS IAM Setup
role_arn='your_role_arn' #arn:aws:iam::1234567890:role/SellingPartnerAPIRole
)
.. note::
In this example we used the IAM ROLE to configure the app in Seller Central, so we must also use the ROLE Arn to configure the Python SPAPI.
Should you have chosen an alternate setup, you may need to drop the `role_arn` from your configuration.


**Example Screenshots**


Expand Down
6 changes: 0 additions & 6 deletions docs/from_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,9 @@ If you pass a value in credentials, other credentials from env variables or from
Orders(refresh_token='...')
.. warning::
If you have assigned the execute-api (STS) permissions to your AWS **user**, omit `role_arn`.

If you have assigned the permissions to a role, the `role_arn` parameter is required.

.. code-block:: python
credentials=dict(
refresh_token='<refresh_token>',
lwa_app_id='<lwa_app_id>',
Expand Down
8 changes: 0 additions & 8 deletions sp_api/base/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import os
from json import JSONDecodeError

from cachetools import TTLCache
from requests import request

from sp_api.auth import AccessTokenClient, AccessTokenResponse
Expand All @@ -17,8 +16,6 @@

log = logging.getLogger(__name__)

role_cache = TTLCache(maxsize=int(os.environ.get('SP_API_AUTH_CACHE_SIZE', 10)), ttl=3200)


class Client(BaseClient):
grantless_scope: str = ''
Expand Down Expand Up @@ -58,11 +55,6 @@ def __init__(
self.version = version
self.verify = verify

def _get_cache_key(self, token_flavor=''):
return 'role_' + hashlib.md5(
(token_flavor + self._auth.cred.refresh_token).encode('utf-8')
).hexdigest()

@property
def headers(self):
return {
Expand Down
9 changes: 0 additions & 9 deletions sp_api/base/credential_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,6 @@ def load_credentials(self):
refresh_token=secret.get('SP_API_REFRESH_TOKEN'),
lwa_app_id=secret.get('LWA_APP_ID'),
lwa_client_secret=secret.get('LWA_CLIENT_SECRET'),
aws_secret_key=secret.get('SP_API_SECRET_KEY'),
aws_access_key=secret.get('SP_API_ACCESS_KEY'),
role_arn=secret.get('SP_API_ROLE_ARN')
)

@abc.abstractmethod
Expand Down Expand Up @@ -134,9 +131,6 @@ def load_credentials(self):
refresh_token=self._get_env('SP_API_REFRESH_TOKEN'),
lwa_app_id=self._get_env('LWA_APP_ID'),
lwa_client_secret=self._get_env('LWA_CLIENT_SECRET'),
aws_secret_key=self._get_env('SP_API_SECRET_KEY'),
aws_access_key=self._get_env('SP_API_ACCESS_KEY'),
role_arn=self._get_env('SP_API_ROLE_ARN')
)
self.credentials = account_data

Expand Down Expand Up @@ -181,6 +175,3 @@ def __init__(self, **kwargs):
self.refresh_token = kwargs.get('refresh_token')
self.lwa_app_id = kwargs.get('lwa_app_id')
self.lwa_client_secret = kwargs.get('lwa_client_secret')
self.aws_access_key = kwargs.get('aws_access_key')
self.aws_secret_key = kwargs.get('aws_secret_key')
self.role_arn = kwargs.get('role_arn')
14 changes: 0 additions & 14 deletions tests/client/test_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
refresh_token = '<refresh_token>'
lwa_app_id = '<lwa_app_id>'
lwa_client_secret = '<lwa_client_secret>'
aws_secret_key = '<aws_secret_access_key>'
aws_access_key = '<aws_access_key_id>'
role_arn = '<role_arn>'


def test_auth_exception():
Expand All @@ -24,8 +21,6 @@ def test_credentials():
assert x.credentials is not None
assert x.credentials.lwa_app_id is not None
assert x.credentials.lwa_client_secret is not None
assert x.credentials.aws_secret_key is not None
assert x.credentials.aws_access_key is not None


def test_credentials_with_custom_provider():
Expand All @@ -35,29 +30,20 @@ def load_credentials(self):
"refresh_token": refresh_token,
"lwa_app_id": lwa_app_id,
"lwa_client_secret": lwa_client_secret,
"aws_secret_key": aws_secret_key,
"aws_access_key": aws_access_key,
"role_arn": role_arn,
}

cp = CredentialProvider(credential_providers=(CustomCredentialProvider,))
assert cp.credentials is not None
assert cp.credentials.refresh_token == "<refresh_token>"
assert cp.credentials.lwa_app_id == "<lwa_app_id>"
assert cp.credentials.lwa_client_secret == "<lwa_client_secret>"
assert cp.credentials.aws_secret_key == "<aws_secret_access_key>"
assert cp.credentials.aws_access_key == "<aws_access_key_id>"
assert cp.credentials.role_arn == "<role_arn>"


def test_auth_client():
client = AccessTokenClient(credentials=CredentialProvider(credentials=dict(
refresh_token=refresh_token,
lwa_app_id=lwa_app_id,
lwa_client_secret=lwa_client_secret,
aws_secret_key=aws_secret_key,
aws_access_key=aws_access_key,
role_arn=role_arn,
)).credentials)
x = client._auth_code_request_body('foo')
assert x.get('grant_type') == 'authorization_code'
Expand Down
36 changes: 1 addition & 35 deletions tests/client/test_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@
refresh_token = '<refresh_token>'
lwa_app_id = '<lwa_app_id>'
lwa_client_secret = '<lwa_client_secret>'
aws_secret_key = '<aws_secret_access_key>'
aws_access_key = '<aws_access_key_id>'
role_arn = '<role_arn>'


class Res:
Expand Down Expand Up @@ -56,37 +53,18 @@ def test_from_code_credential_provider():
refresh_token=refresh_token,
lwa_app_id=lwa_app_id,
lwa_client_secret=lwa_client_secret,
aws_secret_key=aws_secret_key,
aws_access_key=aws_access_key,
role_arn=role_arn,
))
assert p.credentials is not None
assert isinstance(p.credentials, dict)


def test_from_code_credential_provider_no_role():
def test_from_code_credential_provider_no_refresh_token():
p = FromCodeCredentialProvider(credentials=dict(
refresh_token=refresh_token,
lwa_app_id=lwa_app_id,
lwa_client_secret=lwa_client_secret,
aws_secret_key=aws_secret_key,
aws_access_key=aws_access_key,
))
assert p.credentials is not None
assert isinstance(p.credentials, dict)
assert p.credentials.get('role_arn') is None


def test_from_code_credential_provider_no_role_no_refresh_token():
p = FromCodeCredentialProvider(credentials=dict(
lwa_app_id=lwa_app_id,
lwa_client_secret=lwa_client_secret,
aws_secret_key=aws_secret_key,
aws_access_key=aws_access_key,
))
assert p.credentials is not None
assert isinstance(p.credentials, dict)
assert p.credentials.get('role_arn') is None
assert p.credentials.get('refresh_token') is None


Expand All @@ -95,19 +73,13 @@ def test_env_vars_provider():
os.environ['SP_API_REFRESH_TOKEN'] = 'foo'
os.environ['LWA_APP_ID'] = 'foo'
os.environ['LWA_CLIENT_SECRET'] = 'foo'
os.environ['SP_API_ACCESS_KEY'] = 'foo'
os.environ['SP_API_SECRET_KEY'] = 'foo'
os.environ['SP_API_ROLE_ARN'] = 'foo'

p = FromEnvironmentVariablesCredentialProvider()()
assert 'refresh_token' in p

os.environ.pop('SP_API_REFRESH_TOKEN')
os.environ.pop('LWA_APP_ID')
os.environ.pop('LWA_CLIENT_SECRET')
os.environ.pop('SP_API_ACCESS_KEY')
os.environ.pop('SP_API_SECRET_KEY')
os.environ.pop('SP_API_ROLE_ARN')


@pytest.mark.order(-1)
Expand Down Expand Up @@ -140,15 +112,12 @@ def test_client():
assert client.credentials is not None
assert client.endpoint == Marketplaces.UK.endpoint
assert client.region == Marketplaces.UK.region
assert client.boto3_client is not None
assert client.restricted_data_token is None
assert isinstance(client._auth, AccessTokenClient)

assert isinstance(client._get_cache_key(), str)
assert isinstance(client._get_cache_key('test'), str)

assert client.set_role() is not None

assert client.headers['host'] == client.endpoint[8:]
assert len(client.headers.keys()) == 5

Expand All @@ -158,9 +127,6 @@ def test_client():
except MissingScopeException as e:
assert isinstance(e, MissingScopeException)

assert client.role is not None
assert client._sign_request is not None

try:
client._request('', data={})
except SellingApiForbiddenException as e:
Expand Down
9 changes: 0 additions & 9 deletions tests/client/test_credential_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
REFRESH_TOKEN = '<refresh_token>'
LWA_APP_ID = '<lwa_app_id>'
LWA_CLIENT_SECRET = '<lwa_client_secret>'
AWS_SECRET_KEY = '<aws_secret_access_key>'
AWS_ACCESS_KEY = '<aws_access_key_id>'
ROLE_ARN = '<role_arn>'


def test_from_cached_secrets_cp_without_secret_id_set():
Expand All @@ -34,9 +31,6 @@ def test_from_cached_secrets_cp_with_cache_available():
"SP_API_REFRESH_TOKEN": REFRESH_TOKEN,
"LWA_APP_ID": LWA_APP_ID,
"LWA_CLIENT_SECRET": LWA_CLIENT_SECRET,
"SP_API_ACCESS_KEY": AWS_ACCESS_KEY,
"SP_API_SECRET_KEY": AWS_SECRET_KEY,
"SP_API_ROLE_ARN": ROLE_ARN,
}

with mock.patch.dict(os.environ, {"SP_API_AWS_SECRET_ID": "test"}), \
Expand All @@ -48,7 +42,4 @@ def test_from_cached_secrets_cp_with_cache_available():
"refresh_token": REFRESH_TOKEN,
"lwa_app_id": LWA_APP_ID,
"lwa_client_secret": LWA_CLIENT_SECRET,
"aws_access_key": AWS_ACCESS_KEY,
"aws_secret_key": AWS_SECRET_KEY,
"role_arn": ROLE_ARN,
}

0 comments on commit e696981

Please sign in to comment.