Custom Script Debugging#

The following guide will explain how to debug custom interception scripts.

Community Edition - VM

Setup#

The following instructions assume Gluu Server is already installed and available. If not, perform a standard Gluu Server installation, then do the following:

Install https://repo.gluu.org/tools/tools-install.sh
Log out of CE
Run /opt/gluu-server/opt/gluu/bin/prepare-dev-tools.py
Log in to CE
Run /opt/gluu/bin/eclipse.sh

Once complete, start the PyDev debug server:

Open the Eclipse Debug perspective
Run this command from the menu: Pydev > Start Debug Server

Development & Debugging#

Now we are ready to perform script development and debugging. Here is a quick overview:

In order to simplify development, put the script into a shared folder like /root/eclipse-workspace
Then instruct oxAuth to load the script from the file system instead of LDAP
Add debug instructions to the script, as specified in the next section
Execute the script

Enable Remote Debug in Custom Script#

After the import section, add:

REMOTE_DEBUG = True

if REMOTE_DEBUG:
    try:
        import sys
        sys.path.append('/opt/libs/pydevd')
        import pydevd
    except ImportError as ex:
        print "Failed to import pydevd: %s" % ex
        raise

Add the following lines wherever breakpoints are needed:

if REMOTE_DEBUG:
    pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)

Sample Scenario#

Log in to oxAuth
Navigate to Manage Custom Script Section
Expand Basic script section
Copy the script to /root/eclipse-workspace/basic.py
Change script Location type to File
Specify the Script Path location to: /root/eclipse-workspace/basic.py
Enable the script
Check the following log to verify that oxAuth loaded the script properly: /opt/gluu/jetty/oxauth/logs/oxauth_script.log. It should look like this:
```
... (PythonService.java:239) - Basic. Initialization

... (PythonService.java:239) - Basic. Initialized successfully
```
Open the following file in Eclipse: /root/eclipse-workspace/basic.py
When opening the Python file for the first time, we need to instruct Eclipse to use a specific interpreter. Follow these steps:
- Press the "Manual Config" button in the dialog box after opening the Python file
- Open "PyDev->Interpreters->Jython Interpreters"
- Click the "New..." button in the right panel. Name it "Jython" and specify the interpreter executable "/opt/jython/jython.jar"
- Click "OK", then confirm the settings by clicking "OK" again, then "Apply and Close"
- In the final dialog, confirm the settings by clicking "OK"

Open basic.py in a file editor. After the import section, add the following lines to load the PyDev libraries:

REMOTE_DEBUG = True  

if REMOTE_DEBUG:  
    try:  
        import sys  
        sys.path.append('/opt/libs/pydevd')  
        import pydevd  
    except ImportError as ex:  
        print "Failed to import pydevd: %s" % ex  
        raise

Add this break condition to the first line in the authenticate method:

if REMOTE_DEBUG:   
    pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)

Save basic.py
Within one minute, oxAuth should load the changed file. Check the following log file again to make sure there are no load errors: /opt/gluu/jetty/oxauth/logs/oxauth_script.log
To check if the script works, update the default authentication method to Basic Authentication. This can be performed in oxTrust by navigating to Manage Authentication > Default Authentication Method
Open another browser or session and try to log in. Make sure to keep the first session open in order to disable the Basic Authentication method in case the script doesn't work as expected.
After executing pydevd.settrace the script will transfer execution control to the PyDev server in Eclipse. You can use any debug commands. For example: Step Over (F6), Resume (F8), etc
After debugging is finished, resume script execution to transfer execution control back to oxAuth

Additional Resources#

Remote debugger

X Server troubleshooting#

Running /opt/gluu-server/opt/gluu/bin/prepare-dev-tools.py allows Eclipse to access X server.

It runs the following commands:

# Only this one key is needed to access from chroot 
xauth -f /root/.Xauthority-gluu generate :0 . trusted 2>1 >> /root/prepare-dev-tools.log

# Generate our own key, xauth requires 128 bit hex encoding
xauth -f /root/.Xauthority-gluu add ${HOST}:0 . $(xxd -l 16 -p /dev/urandom)

# Copy result key to chroot
cp -f /root/.Xauthority-gluu /opt/gluu-server/root/.Xauthority

# Allow to access local server X11   
sudo su $(logname) -c "xhost +local:

Unable to access x11#

If Eclipse is unable to access X11, run the following command from the host to check if it has the necessary permissisons:

user@u144:~$ xhost +local:
non-network local connections being added to access control list
user@u144:~$ xhost 
access control enabled, only authorized clients can connect
LOCAL:
SI:localuser:user

If the user is still unable to access X11, remove .Xauthority from user home and log out/log in again.

Cloud Native Edition - Kubernetes

Setup#

For development the kubernetes setup must be local and accessible to the debug server address. The following steps will walk you trough a setup using Minikube with docker driver, and ksync for syncing the files between local and the container. The following instructions assume a fresh ubuntu 20.04, however the setup can be done on a diffrrent operating systems such as macOS or Windows.

System Requirements#

The minimum system requirement for running all Gluu services are 8GB RAM, 4 CPU, and 50GB disk. This can be dropped to 4GB RAM, 4CPU and 20GB disk space if operating with required services oxTrust, oxAuth, Jackrabbit , and LDAP.

Setup Minikube#

Install Docker 18.09 or higher. For other operating systems follow the appropriate docs.
Install minikube but do not start it yet.
Install kubectl.
Once Minikube is installed start it with the docker driver.
```
minikube start --driver=docker
```
If not automatically set configure kubectl to use the cluster:
```
kubectl config use-context minikube
```
Enable ingress on minikube
```
minikube addons enable ingress
```

Install Gluu#

Install Helm3
Download pygluu-kubernetes.pyz. This package can be built manually.
Optional: If using couchbase as the persistence backend. Download the couchbase kubernetes operator package for linux and place it in the same directory as pygluu-kubernetes.pyz
Run :

./pygluu-kubernetes.pyz helm-install

Install Ksync#

Once Gluu is fully running we want to create an active sync between a local folder, and the folder that will hold the interception scripts inside the oxAuth server container.

Create a folder that will hold the interception script inside the oxAuth container. Place the namespace where gluu is installed in the env GLUU_NAMESPACE and execute:

GLUU_NAMESPACE=<gluu-namespace>
for pod in $(kubectl get pods -n $GLUU_NAMESPACE --selector=app=oxauth --output=jsonpath={.items..metadata.name}); do
    kubectl exec -ti $pod -n $GLUU_NAMESPACE -- mkdir -p /opt/gluu/interception-scripts-ksync
done

Install ksync

curl https://ksync.github.io/gimme-that/gimme.sh | bash

Initialize ksync
```
ksync init -n <gluu-namespace>
```
Start ksync.
```
ksync watch -n <gluu-namespace> &
```
Open a new terminal and create a folder called interception-scripts-ksync
```
mkdir -p $(pwd)/interception-scripts-ksync
```

Create a spec to start syncing folders between local and oxAuth container.

ksync create --selector=app=oxauth $(pwd)/interception-scripts-ksync /opt/gluu/interception-scripts-ksync -n <gluu-namespace>

Check the status. Also check the terminal where the watch command is running.
```
ksync get
```
Move the interception script to the local folder $(pwd)/interception-scripts-ksync. In this example we logged in Gluu, Configuration -> Person Authentication Scripts -> basic and copied the script to the local folder.

Install an IDE#

The IDE can be of choice but must contain PyDev. We chose Liclipse for this demonstartion.