Skip to content

Secrets cleanup #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 23, 2025
Merged

Secrets cleanup #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af3eaa3
Secrets cleanup
justmobilize Feb 22, 2025
6c353a2
Copyedit error messages
dhalbert Feb 23, 2025
57f092f
ruff
dhalbert Feb 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 60 additions & 44 deletions adafruit_portalbase/network.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import gc
import os
import time
import warnings

from adafruit_fakerequests import Fake_Requests
from adafruit_io.adafruit_io import IO_HTTP, AdafruitIO_RequestError
Expand Down Expand Up @@ -57,11 +58,18 @@
CONTENT_JSON = const(2)
CONTENT_IMAGE = const(3)

OLD_SETTINGS = {
OLD_SECRETS = {
"ADAFRUIT_AIO_KEY": "aio_key",
"ADAFRUIT_AIO_USERNAME": "aio_username",
"AIO_KEY": "aio_key",
"AIO_USERNAME": "aio_username",
"CIRCUITPY_WIFI_SSID": "ssid",
"CIRCUITPY_WIFI_PASSWORD": "password",
"AIO_USERNAME": "aio_username",
"AIO_KEY": "aio_key",
}

OLD_SETTINGS = {
"ADAFRUIT_AIO_KEY": "AIO_KEY",
"ADAFRUIT_AIO_USERNAME": "AIO_USERNAME",
}


Expand All @@ -83,12 +91,11 @@ class NetworkBase:
:param bool extract_values: If true, single-length fetched values are automatically extracted
from lists and tuples. Defaults to ``True``.
:param debug: Turn on debug print outs. Defaults to False.
:param list secrets_data: An optional list in place of the data contained in the secrets.py file

"""

def __init__( # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in function definition
self, wifi_module, *, extract_values=True, debug=False, secrets_data=None
self, wifi_module, *, extract_values=True, debug=False
):
self._wifi = wifi_module
self._debug = debug
Expand All @@ -101,11 +108,6 @@ def __init__( # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in f
]

self._settings = {}
if secrets_data is not None:
for key, value in secrets_data.items():
if key in OLD_SETTINGS:
key = OLD_SETTINGS.get(key) # noqa: PLW2901 `for` loop variable `value` overwritten by assignment target
self._settings[key] = value
self._wifi_credentials = None

self.requests = None
Expand All @@ -120,31 +122,44 @@ def __init__( # noqa: PLR0912,PLR0913 Too many branches,Too many arguments in f

gc.collect()

def _get_setting(self, setting_name, show_error=True):
def _get_setting(self, setting_name):
# if setting is has already been found, return it
if setting_name in self._settings:
return self._settings[setting_name]

old_setting_name = setting_name
# if setting is in settings.toml return it
env_value = os.getenv(setting_name)
if env_value is not None:
self._settings[setting_name] = env_value
return env_value

# if setting old name is in settings.toml return it
if setting_name in OLD_SETTINGS:
old_setting_name = OLD_SETTINGS.get(setting_name)
if os.getenv(setting_name) is not None:
return os.getenv(setting_name)
env_value = os.getenv(old_setting_name)
if env_value is not None:
self._settings[setting_name] = env_value
return env_value

try:
from secrets import secrets
except ImportError:
secrets = {}
if old_setting_name in secrets.keys():
self._settings[setting_name] = secrets[old_setting_name]
return self._settings[setting_name]
if show_error:
if setting_name in ("CIRCUITPY_WIFI_SSID", "CIRCUITPY_WIFI_PASSWORD"):
print(
"""WiFi settings are kept in settings.toml, please add them there!
the secrets dictionary must contain 'CIRCUITPY_WIFI_SSID' and 'CIRCUITPY_WIFI_PASSWORD'
at a minimum in order to use network related features"""
)
else:
print(f"{setting_name} not found. Please add this setting to settings.toml.")
return None

# if setting is in legacy secrets.py return it
secrets_setting_name = setting_name
if setting_name in OLD_SECRETS:
# translate common names
secrets_setting_name = OLD_SECRETS.get(setting_name)
env_value = secrets.get(secrets_setting_name)
if env_value is not None:
warnings.warn(
"Using secrets.py for network settings is deprecated."
" Put your settings in settings.toml."
)
self._settings[setting_name] = env_value
return env_value

return None

def neo_status(self, value):
Expand Down Expand Up @@ -206,17 +221,17 @@ def get_strftime(self, time_format, location=None, max_attempts=10):
api_url = None
reply = None
try:
aio_username = self._get_setting("AIO_USERNAME")
aio_key = self._get_setting("AIO_KEY")
aio_username = self._get_setting("ADAFRUIT_AIO_USERNAME")
aio_key = self._get_setting("ADAFRUIT_AIO_KEY")
except KeyError:
raise KeyError(
"\n\nOur time service requires a login/password to rate-limit. "
"Please register for a free adafruit.io account and place the user/key "
"in your secrets file under 'AIO_USERNAME' and 'AIO_KEY'"
"\nThe Adafruit IO time service requires a login and password. "
"Rgister for a free adafruit.io account and put the username and key in "
"your settings.toml file under 'ADAFRUIT_AIO_USERNAME' and 'ADAFRUIT_AIO_KEY'"
) from KeyError

if location is None:
location = self._get_setting("timezone", False)
location = self._get_setting("timezone")
if location:
print("Getting time for timezone", location)
api_url = (TIME_SERVICE + "&tz=%s") % (aio_username, aio_key, location)
Expand All @@ -242,7 +257,8 @@ def get_strftime(self, time_format, location=None, max_attempts=10):
reply = response.text
except KeyError:
raise KeyError(
"Was unable to lookup the time, try setting secrets['timezone'] according to http://worldtimeapi.org/timezones"
"Unable to lookup the time, try setting 'timezone' in your settings.toml"
"according to http://worldtimeapi.org/timezones"
) from KeyError
# now clean up
response.close()
Expand Down Expand Up @@ -346,7 +362,7 @@ def wget(self, url, filename, *, chunk_size=12000, headers=None):

def connect(self, max_attempts=10):
"""
Connect to WiFi using the settings found in secrets.py
Connect to WiFi using the settings found in settings.toml

:param max_attempts: The maximum number of attempts to connect to WiFi before
failing or use None to disable. Defaults to 10.
Expand All @@ -361,7 +377,7 @@ def connect(self, max_attempts=10):
}
]

networks = self._get_setting("networks", False)
networks = self._get_setting("networks")
if networks is not None:
if isinstance(networks, (list, tuple)):
self._wifi_credentials = networks
Expand All @@ -370,14 +386,14 @@ def connect(self, max_attempts=10):
"'networks' must be a list/tuple of dicts of 'ssid' and 'password'"
)

for secret_entry in self._wifi_credentials:
for credentials in self._wifi_credentials:
self._wifi.neo_status(STATUS_CONNECTING)
attempt = 1

while not self._wifi.is_connected:
# secrets dictionary must contain 'ssid' and 'password' at a minimum
print("Connecting to AP", secret_entry["ssid"])
if secret_entry["ssid"] == "CHANGE ME" or secret_entry["password"] == "CHANGE ME":
# credentials must contain 'CIRCUITPY_WIFI_SSID' and 'CIRCUITPY_WIFI_PASSWORD'
print("Connecting to AP", credentials["ssid"])
if credentials["ssid"] == "CHANGE ME" or credentials["password"] == "CHANGE ME":
change_me = "\n" + "*" * 45
change_me += "\nPlease update the 'settings.toml' file on your\n"
change_me += "CIRCUITPY drive to include your local WiFi\n"
Expand All @@ -387,7 +403,7 @@ def connect(self, max_attempts=10):
raise OSError(change_me)
self._wifi.neo_status(STATUS_NO_CONNECTION) # red = not connected
try:
self._wifi.connect(secret_entry["ssid"], secret_entry["password"])
self._wifi.connect(credentials["ssid"], credentials["password"])
self.requests = self._wifi.requests
self._wifi.neo_status(STATUS_CONNECTED)
break
Expand All @@ -412,11 +428,11 @@ def _get_io_client(self):
self.connect()

try:
aio_username = self._get_setting("AIO_USERNAME")
aio_key = self._get_setting("AIO_KEY")
aio_username = self._get_setting("ADAFRUIT_AIO_USERNAME")
aio_key = self._get_setting("ADAFRUIT_AIO_KEY")
except KeyError:
raise KeyError(
"Adafruit IO secrets are kept in secrets.py, please add them there!\n\n"
"Adafruit IO settings are kept in settings.toml, please add them there!\n\n"
) from KeyError

self._io_client = IO_HTTP(aio_username, aio_key, self._wifi.requests)
Expand Down
13 changes: 2 additions & 11 deletions adafruit_portalbase/wifi_coprocessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ def __init__(self, *, status_led=None, esp=None, external_spi=None):

if self.esp.is_connected:
self._set_requests()
self._manager = None

gc.collect()

Expand All @@ -81,9 +80,9 @@ def _set_requests(self):

def connect(self, ssid, password):
"""
Connect to WiFi using the settings found in secrets.py
Connect to WiFi using the settings found in settings.toml
"""
self.esp.connect({"ssid": ssid, "password": password})
self.esp.connect(ssid, password)
self._set_requests()

def neo_status(self, value):
Expand All @@ -95,14 +94,6 @@ def neo_status(self, value):
if self.neopix:
self.neopix.fill(value)

def manager(self, secrets):
"""Initialize the WiFi Manager if it hasn't been cached and return it"""
if self._manager is None:
self._manager = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(
self.esp, secrets, None
)
return self._manager

@property
def is_connected(self):
"""Return whether we are connected."""
Expand Down
8 changes: 4 additions & 4 deletions examples/portalbase_simpletest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
used directly by end users. This example shows one such usage with the PyPortal library.
See MatrixPortal, MagTag, and PyPortal libraries for more examples.
"""
# NOTE: Make sure you've created your secrets.py file before running this example
# https://learn.adafruit.com/adafruit-pyportal/internet-connect#whats-a-secrets-file-17-2
# NOTE: Make sure you've created your settings.toml file before running this example
# https://learn.adafruit.com/adafruit-pyportal/create-your-settings-toml-file

import board
import displayio
from adafruit_pyportal import PyPortal
from displayio import CIRCUITPYTHON_TERMINAL

# Set a data source URL
TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
Expand All @@ -20,7 +20,7 @@
pyportal = PyPortal(url=TEXT_URL, status_neopixel=board.NEOPIXEL)

# Set display to show REPL
board.DISPLAY.root_group = displayio.CIRCUITPYTHON_TERMINAL
board.DISPLAY.root_group = CIRCUITPYTHON_TERMINAL

# Go get that data
print("Fetching text from", TEXT_URL)
Expand Down
2 changes: 2 additions & 0 deletions optional_requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense

pytest
Loading