Installation

Table of Contents generated with DocToc

• Python Interpreter Requirements
• OS requirements
  • Install bpftrace (for Linux)
  • Install dtrace (for Mac, Solaris, Windows)
    • Using Docker: bpftrace (Linux, Mac)
• Install Python with USDT probes and openssl (from source): ~5 minutes
  • Test the interpreter
  • Run secimport Tests
• What's Next?

Python Interpreter Requirements

The only runtime requirement is a Python interpreter that was built with --with-dtrace (USDT probes).
You can check if your current interpreter supported by running readelf on your python interpreter:

readelf -n Python-3.10.0/python | grep -i function__entry

You should be able to see the following output:

    Name: function__entry

If your current interpreter is not supported (empty output):

• Using pip
  • python3 -m pip install secimport
• Using poetry
  • python3 -m pip install poetry && python3 -m poetry build
    
    

OS requirements

Install bpftrace (for Linux)

Install bpftrace toolkit from https://github.com/iovisor/bpftrace/blob/master/INSTALL.md . Then, proceed to the python interpreter.

Install dtrace (for Mac, Solaris, Windows)

Some distributions include dtrace. check the dtrace command. If it is not installed:

yum install dtrace-utils

Using Docker: bpftrace (Linux, Mac)

the docker/ folder includes everything in the following guide. To build and run using docker, see Docker,

Install Python with USDT probes and openssl (from source): ~5 minutes

If you want to use pip to work properly with pypi, you should also install openssl. To support ssl in this interpreter, One can simply install openssl pacakge using apt/yum/apk and it will use it automatically.
If you wish to build openssl from source

Download and build openssl

wget https://www.openssl.org/source/openssl-1.1.1h.tar.gz
tar -xvf openssl-1.1.1h.tar.gz
cd openssl-1.1.1h
./config --prefix=$(pwd)/openssl --openssldir=$(pwd)/openssl
make
make test
make install

Download python

PYTHON_VERSION="3.10.0"

cd /tmp
curl -o Python-$PYTHON_VERSION.tgz https://www.python.org/ftp/python/$PYTHON_VERSION/Python-$PYTHON_VERSION.tgz
tar -xzf Python-$PYTHON_VERSION.tgz

If you want to use a custom OpenSSL version/installation, edit the OPENSSL variable in Modules/Setup:

$ nano Python-$PYTHON_VERSION/Modules/Setup

OPENSSL=/path/to/openssl-1.1.1h/openssl
_ssl _ssl.c \
    -I$(OPENSSL)/include -L$(OPENSSL)/lib \
    -lssl -lcrypto


# Configuring and install with dtrace, pip and openssl
cd Python-$PYTHON_VERSION && ./configure --with-dtrace  --prefix=$(pwd) --with-ensurepip=install && make

# Optionsl: test your build
make test

# Optional: Install alongside your existing python without replacing it.
make altinstall

Test the interpreter

➜  Python-3.10.0 ./python

Python 3.10.0 (default, Jul  6 2022, 09:21:12) [Clang 13.0.0 (clang-1300.0.27.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import ssl
>>> # You're good to go!

Run secimport Tests

python3 -m pytest

What's Next?

You can proceed to EXAMPLES.md