oauthenticator.awscognito.AWSCognitoAuthenticator could not be imported

ZackInNC · November 22, 2021, 12:18pm

I have 2 side-by-side ubuntu servers (EC2).

On one, I followed the vanilla install instructions, including SSL and Cognito integration, and it works as expected.

On the other, I did the same thing, except that the machine was already setup with python and a conda environment.

In the latter, when I try to use Cognito for authentication (specified below), I get this error:

python3[86637]: [C 2021-11-22 12:03:19.200 JupyterHub application:90] Bad config encountered during initialization: The ‘authenticator_class’ trait of <main.JupyterHub object at 0x7f28f60dcb50> instance must be a type, but ‘oauthenticator.awscognito.AWSCognitoAuthenticator’ could not be imported

Here’s how I setup the SSL and cognito integration:

sudo tljh-config set https.enabled true
sudo tljh-config set https.letsencrypt.emal me@me.com
sudo tljh-config add-item https.letsencrypt.domains
sudo tljh-config add-item https.letsencrypt.domains
sudo tljh-config reload proxy

create conf file:

sudo vi /etc/systemd/system/jupyterhub.service.d/jupyterhub.conf

With these contents:
[Service]
Environment=AWSCOGNITO_DOMAIN=

#create awscognito.py
sudo vi /opt/tljh/config/jupyterhub_config.d/awscognito.py

with these contents:
##############################################
Setup aws Cognito Authenticator
##############################################
AWSCognitoAuthenticator.client_id=‘abc’
AWSCognitoAuthenticator.client_secret=‘xyz’
AWSCognitoAuthenticator.oauth_callback_url=’’
AWSCognitoAuthenticator.username_key=‘email’
AWSCognitoAuthenticator.oauth_logout_redirect_url=’’

These instructions alone worked for the server that didn’t have conda and python setup in advance.

I also tried this, but everything was already installed:

pip install -U oauthenticator

I also tried updating the symlinks for python and pip under the the tljh install to point at the conda python installation - also to no avail.

Note that the first instance was installed several weeks ago, and is on python version 3.6.9 and the latter is on python version 3.8.8

Can anyone help me understand what I’m missing here?

ZackInNC · November 22, 2021, 12:19pm

manics · November 22, 2021, 9:59pm

My guess is that you’ve installed something into the wrong environment. Can you run conda list and pip list in all of your environments?

ZackInNC · November 23, 2021, 12:01pm

From the machine having issues:

(base) ubuntu@my-machine:~$ conda list

packages in environment at /home/ubuntu/anaconda3:

ZackInNC · November 23, 2021, 12:03pm

(base) ubuntu@my-machine:~$ pip list
Package Version

alabaster 0.7.12
alembic 1.7.5
anaconda-client 1.7.2
anaconda-navigator 2.0.3
anaconda-project 0.9.1
anyio 2.2.0
appdirs 1.4.4
argh 0.26.2
argon2-cffi 20.1.0
asn1crypto 1.4.0
astroid 2.5
astropy 4.2.1
async-generator 1.10
atomicwrites 1.4.0
attrs 20.3.0
autopep8 1.5.6
Babel 2.9.0
backcall 0.2.0
backports.functools-lru-cache 1.6.4
backports.shutil-get-terminal-size 1.0.0
backports.tempfile 1.0
backports.weakref 1.0.post1
beautifulsoup4 4.9.3
bitarray 2.1.0
bkcharts 0.2
black 19.10b0
bleach 3.3.0
bokeh 2.3.2
boto 2.49.0
Bottleneck 1.3.2
brotlipy 0.7.0
certifi 2020.12.5
certipy 0.1.3
cffi 1.14.5
chardet 4.0.0
click 7.1.2
cloudpickle 1.6.0
clyent 1.2.2
colorama 0.4.4
conda 4.10.1
conda-build 3.21.4
conda-content-trust 0+unknown
conda-package-handling 1.7.3
conda-repo-cli 1.0.4
conda-token 0.3.0
conda-verify 3.4.2
contextlib2 0.6.0.post1
cryptography 3.4.7
cycler 0.10.0
Cython 0.29.23
cytoolz 0.11.0
dask 2021.4.0
decorator 5.0.6
defusedxml 0.7.1
diff-match-patch 20200713
distributed 2021.4.1
docutils 0.17.1
ecdsa 0.17.0
entrypoints 0.3
et-xmlfile 1.0.1
fastcache 1.1.0
filelock 3.0.12
flake8 3.9.0
Flask 1.1.2
Flask-AWSCognito 1.3
fsspec 0.9.0
future 0.18.2
gevent 21.1.2
glob2 0.7
gmpy2 2.0.8
greenlet 1.0.0
h5py 2.10.0
HeapDict 1.0.1
html5lib 1.1
idna 2.10
imageio 2.9.0
imagesize 1.2.0
importlib-metadata 3.10.0
importlib-resources 5.4.0
iniconfig 1.1.1
intervaltree 3.1.0
ipykernel 5.3.4
ipython 7.22.0
ipython-genutils 0.2.0
ipywidgets 7.6.3
isort 5.8.0
itsdangerous 1.1.0
jdcal 1.4.1
jedi 0.17.2
jeepney 0.6.0
Jinja2 2.11.3
joblib 1.0.1
json5 0.9.5
jsonschema 3.2.0
jupyter 1.0.0
jupyter-client 6.1.12
jupyter-console 6.4.0
jupyter-core 4.7.1
jupyter-packaging 0.7.12
jupyter-server 1.4.1
jupyter-telemetry 0.1.0
jupyterhub 1.5.0
jupyterlab 3.0.14
jupyterlab-pygments 0.1.2
jupyterlab-server 2.4.0
jupyterlab-widgets 1.0.0
keyring 22.3.0
kiwisolver 1.3.1
lazy-object-proxy 1.6.0
libarchive-c 2.9
llvmlite 0.36.0
locket 0.2.1
lxml 4.6.3
Mako 1.1.6
MarkupSafe 1.1.1
matplotlib 3.3.4
mccabe 0.6.1
mistune 0.8.4
mkl-fft 1.3.0
mkl-random 1.2.1
mkl-service 2.3.0
mock 4.0.3
more-itertools 8.7.0
mpmath 1.2.1
msgpack 1.0.2
multipledispatch 0.6.0
mypy-extensions 0.4.3
navigator-updater 0.2.1
nbclassic 0.2.6
nbclient 0.5.3
nbconvert 6.0.7
nbformat 5.1.3
nest-asyncio 1.5.1
networkx 2.5
nltk 3.6.1
nose 1.3.7
notebook 6.3.0
numba 0.53.1
numexpr 2.7.3
numpy 1.20.1
numpydoc 1.1.0
oauthenticator 14.2.0
oauthlib 3.1.1
olefile 0.46
openpyxl 3.0.7
packaging 20.9
pamela 1.0.0
pandas 1.2.4
pandocfilters 1.4.3
parso 0.7.0
partd 1.2.0
path 15.1.2
pathlib2 2.3.5
pathspec 0.7.0
patsy 0.5.1
pep8 1.7.1
pexpect 4.8.0
pickleshare 0.7.5
Pillow 8.2.0
pip 21.0.1
pkginfo 1.7.0
pluggy 0.13.1
ply 3.11
prometheus-client 0.10.1
prompt-toolkit 3.0.17
psutil 5.8.0
ptyprocess 0.7.0
py 1.10.0
pyasn1 0.4.8
pycodestyle 2.6.0
pycosat 0.6.3
pycparser 2.20
pycurl 7.43.0.6
pydocstyle 6.0.0
pyerfa 1.7.3
pyflakes 2.2.0
Pygments 2.8.1
pylint 2.7.4
pyls-black 0.4.6
pyls-spyder 0.3.2
pyodbc 4.0.0-unsupported
pyOpenSSL 20.0.1
pyparsing 2.4.7
pyrsistent 0.17.3
PySocks 1.7.1
pytest 6.2.3
python-dateutil 2.8.1
python-jose 3.3.0
python-json-logger 2.0.2
python-jsonrpc-server 0.4.0
python-language-server 0.36.2
pytz 2021.1
PyWavelets 1.1.1
pyxdg 0.27
PyYAML 5.4.1
pyzmq 20.0.0
QDarkStyle 2.8.1
QtAwesome 1.0.2
qtconsole 5.0.3
QtPy 1.9.0
regex 2021.4.4
requests 2.25.1
rope 0.18.0
rsa 4.7.2
Rtree 0.9.7
ruamel-yaml-conda 0.15.100
ruamel.yaml 0.17.17
ruamel.yaml.clib 0.2.6
scikit-image 0.18.1
scikit-learn 0.24.1
scipy 1.6.2
seaborn 0.11.1
SecretStorage 3.3.1
Send2Trash 1.5.0
setuptools 52.0.0.post20210125
simplegeneric 0.8.1
singledispatch 0.0.0
sip 4.19.13
six 1.15.0
sniffio 1.2.0
snowballstemmer 2.1.0
sortedcollections 2.1.0
sortedcontainers 2.3.0
soupsieve 2.2.1
Sphinx 4.0.1
sphinxcontrib-applehelp 1.0.2
sphinxcontrib-devhelp 1.0.2
sphinxcontrib-htmlhelp 1.0.3
sphinxcontrib-jsmath 1.0.1
sphinxcontrib-qthelp 1.0.3
sphinxcontrib-serializinghtml 1.1.4
sphinxcontrib-websupport 1.2.4
spyder 4.2.5
spyder-kernels 1.10.2
SQLAlchemy 1.4.15
statsmodels 0.12.2
sympy 1.8
tables 3.6.1
tblib 1.7.0
terminado 0.9.4
testpath 0.4.4
textdistance 4.2.1
threadpoolctl 2.1.0
three-merge 0.1.1
tifffile 2020.10.1
toml 0.10.2
toolz 0.11.1
tornado 6.1
tqdm 4.59.0
traitlets 5.0.5
typed-ast 1.4.2
typing-extensions 3.7.4.3
ujson 4.0.2
unicodecsv 0.14.1
urllib3 1.26.4
watchdog 1.0.2
wcwidth 0.2.5
webencodings 0.5.1
Werkzeug 1.0.1
wheel 0.36.2
widgetsnbextension 3.5.1
wrapt 1.12.1
wurlitzer 2.1.0
xlrd 2.0.1
XlsxWriter 1.3.8
xlwt 1.3.0
xmltodict 0.12.0
yapf 0.31.0
zict 2.0.0
zipp 3.4.1
zope.event 4.5.0
zope.interface 5.3.0

manics · November 25, 2021, 7:10pm

It looks like you’ve listed the default Python environment. With TLJH the hub environment is under /opt/tljh/hub.

Are you using the latest version of TLJH?

ZackInNC · November 27, 2021, 1:20pm

I believe so.

Does this look correct?

(base) ubuntu@(my machine):~$ ls -alh /opt/tljh/hub/
total 28K
drwxr-xr-x 6 root root 4.0K Nov 12 19:40 .
drwxr-xr-x 6 root root 4.0K Nov 12 19:41 …
drwxr-xr-x 2 root root 4.0K Nov 22 11:49 bin
drwxr-xr-x 3 root root 4.0K Nov 12 19:41 include
drwxr-xr-x 3 root root 4.0K Nov 12 19:40 lib
lrwxrwxrwx 1 root root 3 Nov 12 19:40 lib64 → lib
-rw-r–r-- 1 root root 70 Nov 12 19:40 pyvenv.cfg
drwxr-xr-x 5 root root 4.0K Nov 12 19:41 share

(base) ubuntu@(my machine):~$ cat /opt/tljh/hub/pyvenv.cfg
home = /usr/bin
include-system-site-packages = false
version = 3.8.10

manics · November 29, 2021, 10:21pm

Is the authenticator installed in your hub environment?

/opt/tljh/hub/bin/pip list

ZackInNC · November 30, 2021, 3:09pm

Does not appear to be:

(base) ubuntu@(my machine):~$ /opt/tljh/hub/bin/pip list
Package Version

aiohttp 3.8.0
aiosignal 1.2.0
alembic 1.7.5
async-generator 1.10
async-timeout 4.0.1
attrs 21.2.0
backoff 1.11.1
bcrypt 3.2.0
certifi 2021.10.8
certipy 0.1.3
cffi 1.15.0
charset-normalizer 2.0.7
cryptography 35.0.0
deepmerge 0.3.0
entrypoints 0.3
escapism 1.0.1
frozenlist 1.2.0
greenlet 1.1.2
idna 3.3
importlib-metadata 4.8.2
importlib-resources 5.4.0
Jinja2 3.0.3
jsonschema 4.2.1
jupyter-telemetry 0.1.0
jupyterhub 1.5.0
jupyterhub-configurator 1.0
jupyterhub-firstuseauthenticator 1.0.0
jupyterhub-idle-culler 1.2.1
jupyterhub-ldapauthenticator 1.3.2
jupyterhub-nativeauthenticator 1.0.5
jupyterhub-systemdspawner 0.15.0
jupyterhub-tmpauthenticator 0.6
jupyterhub-traefik-proxy 0.3.0
ldap3 2.9.1
Mako 1.1.5
MarkupSafe 2.0.1
multidict 5.2.0
oauthenticator 14.2.0
oauthlib 3.1.1
onetimepass 1.0.1
pamela 1.0.0
passlib 1.7.4
pip 21.3.1
pkg_resources 0.0.0
pluggy 1.0.0
prometheus-client 0.12.0
pyasn1 0.4.8
pycparser 2.21
pycurl 7.44.1
pyOpenSSL 21.0.0
pyrsistent 0.18.0
python-dateutil 2.8.2
python-json-logger 2.0.2
requests 2.26.0
ruamel.yaml 0.17.17
ruamel.yaml.clib 0.2.6
setuptools 44.0.0
six 1.16.0
SQLAlchemy 1.4.27
the-littlest-jupyterhub 0.1
toml 0.10.2
tornado 6.1
traitlets 5.1.1
typing-extensions 3.10.0.2
urllib3 1.26.7
yarl 1.7.2
zipp 3.6.0

ZackInNC · December 6, 2021, 3:22pm

What does that mean (or imply)?

ZackInNC · December 9, 2021, 12:59pm

Looks like I have the same libraries on the machine that works and the machine that doesn’t - with the exception of jupyterhub-dummyauthenticator, but the versions are all different.

Machine that does NOT work:
(base) ubuntu@my-machine:~$ /opt/tljh/hub/bin/pip list | grep auth
jupyterhub-firstuseauthenticator 1.0.0
jupyterhub-ldapauthenticator 1.3.2
jupyterhub-nativeauthenticator 1.0.5
jupyterhub-tmpauthenticator 0.6
oauthenticator 14.2.0
oauthlib 3.1.1

Machine that DOES work:
jupyterhub-dummyauthenticator 0.3.1
jupyterhub-firstuseauthenticator 0.14.1
jupyterhub-ldapauthenticator 1.3.0
jupyterhub-nativeauthenticator 0.0.7
jupyterhub-tmpauthenticator 0.6
oauthenticator 0.10.0
oauthlib 3.1.1

ZackInNC · December 9, 2021, 1:23pm

Circling back with a solution:

I explicitly set the version for oauthenticator to 0.10.0:

sudo /opt/tljh/hub/bin/pip install ‘oauthenticator==0.10.0’

And then restarted the service and it worked correctly.

So it appears that TLJH is not compatible with the newer/latest version(s).

Topic		Replies	Views
Error while enabling auth_state persistance for GenericOAuthenticator The Littlest JupyterHub jupyterhub , help-wanted	4	73	August 26, 2024
Bad config encountered during initialization: The authenticator_class trait of... instance must be a type, but jhub_remote_user_authenticator... could not be imported Zero to JupyterHub on Kubernetes jupyterhub , help-wanted	10	2114	October 18, 2022
Problem with SSH Authenticator for JupyterHub JupyterHub	0	441	November 17, 2021
Cognito Authentication for Jupyterhub Helm Chart Zero to JupyterHub on Kubernetes how-to , help-wanted	3	1941	July 15, 2020
Shibboleth Authenticator + OAuthenticator JupyterHub jupyterhub , how-to	4	191	June 4, 2024

oauthenticator.awscognito.AWSCognitoAuthenticator could not be imported

create conf file:

packages in environment at /home/ubuntu/anaconda3:

Name Version Build Channel

Related topics