Low code connectors: Implement Base64Authenticator

[girarda]

What

Some sources (eg amplitude) need a TokenAuthenticator where the token is the base64 representation of "{username}:{password}" where the username and password are encoded in specified encoding (eg latin1 or utf-8)

As it currently stands, this encoding is done in the connector's package, but the logic is always the same, so we should move it to a common package. A simple solution would be to wrap the authenticators with a configurable encoding layer. The authenticators to wrap would be

• airbyte_cdk.sources.streams.http.requests_native_auth.token.MultipleTokenAuthenticator and TokenAuthenticator (amplitude, chartmogul, delighted, freshservice, lemlist, prestashop, twilio, woocommerce, zendesk-sunshine)
• requests.auth.HTTPBasicAuth (chargify, qualaroo)
• airbyte_cdk.sources.streams.http.requests_native_auth.oauth.Oauth2Authenticator (pinterest)

Here are the instances:

• airbyte-integrations/connectors/source-amplitude/source_amplitude/source.py:37
• airbyte-integrations/connectors/source-chargify/source_chargify/source.py:99
• source_chartmogul.source.HttpBasicAuthenticator
• source_commercetools.source.SourceCommercetools._convert_auth_to_token
• airbyte-integrations/connectors/source-delighted/source_delighted/source.py:144
• source_freshservice.source.HttpBasicAuthenticator
• source_lemlist.auth.HttpBasicAuthenticator
• source_pinterest.source.SourcePinterest.get_authenticator
• source_prestashop.source.SourcePrestaShop.get_authenticator
• source_qualaroo.source.QualarooAuthenticator
• source_twilio.auth.HttpBasicAuthenticator
• airbyte-integrations/connectors/source-woocommerce/source_woocommerce/source.py:188
• source_zendesk_sunshine.source.Base64HttpAuthenticator

[girarda]

grooming notes:

• check if pinterest is only encoding the username/password
• can't just subclass the token authenticator since multiple authenticators need to be updated
• no need to actually update the existing connectors ~- username and passwords are encoded separately~
• we should expose md5 function from the jinja template engine so we can directly encode the tokens from the yaml file

[girarda]

notes on how this can be done if we do the encoding/decoding directly in jinja:

• amplitude token: "{{ base64(encode(config['username'] + ':' + config['password'], 'latin1'), 'ascii') }}"
• chargify: nothing to encode. can use api_key directly
• chartmogul: "{{ base64(encode(config['token'] + ':', 'utf8'), 'utf8') }}"
• commercetools: "{{ base64(encode(config['username'] + ':' + config['password'], 'latin1'), 'ascii') }}" (same as amplitude)
• delighted: "{{ base64(encode(config['token'] + ':', 'utf8'), 'utf8') }}" (same as chartmogul)
• freshservice: "{{ base64(encode(config['username'] + ':' + config['password'], 'utf8'), 'utf8') }}"
• lemlist: same as freshservice
• pinterest - here we only want to encode the refresh_access_token_headers: {"Authorization": "{{ 'Basic' + {{ base64(encode(config['username'] + ':' + config['password'], 'ascii'), 'ascii') }}" }
• prestashop: "{{ base64(encode(config['token'] + ':', 'utf8'), 'ascii') }}" (note that this would probably work with decoding to uft-8)
• qualaroo: "{{ base64(encode(config['username'] + ':' + config['password'], 'latin1'), 'ascii') }}" (same as amplitude)
• twilio: "{{ base64(encode(config['username'] + ':' + config['password'], 'utf8'), 'utf8') }}"
• woocommerce: same as amplitude
• zendesk-sunshine: "{{ base64(encode(config['token'] + ':', 'utf8'), 'utf8') }}" (same as freshservice)

I ran a few tests and the base64 form is the same with utf8, ascii, and latin1, so it should be safe to always default to utf8. The template string could then look like: "{{ base64(config['username'] + ':' + config['password']) }}" where we'll do the encoding/decoding behind the scene.

The function should look like self._environment.globals["base64"] = lambda s: b64encode(s.encode("utf8")).decode("utf8")

and the config like:

authenticator:
  class_name: TokenAuthenticator
  token: "{{ base64(config['username'] + ':' + config['password']) }}"