include /etc/firejail/globals.local

# do not assume a shell (and therefore mock a rc file)
# since we want to allow our own shell config (but read-only)
#shell none
keep-shell-rc  # enable this for firejail >0.9.66

### Permission overrides
#
# firejail provides ready-made profiles that are very restrictive (good).
# Here we define what not to disallow.

# we want our vim config to be available but readonly
# the read-only attribute is already imposed by the includes
noblacklist ${HOME}/.vim
noblacklist ${HOME}/.vimrc
whitelist ${HOME}/.vimrc
whitelist ${HOME}/.vim

noblacklist ${HOME}/.tmux.conf
whitelist ${HOME}/.tmux.conf

noblacklist ${HOME}/.zshrc
whitelist ${HOME}/.zshrc

noblacklist ${HOME}/.gitconfig
whitelist ${HOME}/.gitconfig
read-only ${HOME}/.gitconfig
whitelist ${HOME}/.gitignore
read-only ${HOME}/.gitignore
noblacklist ${HOME}/.bashrc
whitelist ${HOME}/.bashrc

# make sure that there's a viminfo file (RW);
# it is temporary and discarded after sandbox shutdown!
mkfile ${HOME}/.viminfo

# Exceptions for tools that we need when developing, such as ssh.
noblacklist ${PATH}/ssh

# necessary for older firejail versions where profile.d is blacklisted
# by disable-common.inc which makes the VTE new-tab feature hard to implement
noblacklist /etc/profile.d

## DBus handling
#
# We allow for owning kde and gnome topics so that we can launch GUI
# applications from the jail but we will disallow access to secrets, i.e.
# org.freedesktop.secrets or ca.desrt.dconf.
#
# This is not a complete list of filters and is to be improved.
dbus-user filter
dbus-user.own org.gnome.*
dbus-user.own org.kde.*
dbus-user.talk org.freedesktop.DBus
dbus-user.talk org.freedesktop.Notifications
dbus-system filter
dbus-system.talk org.freedesktop.login1

include /etc/firejail/disable-common.inc
include /etc/firejail/disable-programs.inc

### Resource limitations
#
# no access to /mnt or /media needed I think
disable-mnt


### Visual hint of jailing
#
# We cannot influence the shell directly since we do not know which
# variables are overriden by config but we can provide a hint that
# we are running inside a jailed environment.
#
# This can, of course, be used against us but I don't see a better way yet.
env JAILED_ENV=€{sandbox_name}


### GPU access
#
noblacklist /sys/module
whitelist /sys/module/nvidia*
read-only /sys/module/nvidia*
noblacklist /dev/nvidia-uvm


### Read-only file system
#
# Files and directories that are allowed to be seen and read but not
# written to.
#
read-only ~/.zshrc
read-only ~/.bashrc

# Every setup is a bit different. To support your local tools that you
# want to have in your environment, you can add custom allowances here.
#
# To do this, create ~/.config/firejail/python-env-template.local
#
# Example content could be:
# whitelist ${HOME}/Code/pyenv/
# read-only ${HOME}/Code/pyenv/
#
# whitelist ${HOME}/Code/fzf
# read-only ${HOME}/Code/fzf
# whitelist ${HOME}/Code/goto-tool
# read-only ${HOME}/Code/goto-tool
#
include python-env-template.local

### Caching directories
#
# persistent directory between invocations
#
mkdir ~/.cache/pysandbox-€{sandbox_name}/
whitelist ~/.cache/pysandbox-€{sandbox_name}/

env HF_HOME=€{HOME}/.cache/pysandbox-€{sandbox_name}/huggingface
env PIP_CACHE_DIR=€{HOME}/.cache/pysandbox-€{sandbox_name}/pip
env CONDA_ENVS_PATH=€{env_dir}/€{sandbox_name}/conda
env CONDA_PKGS_DIRS=€{env_dir}/€{sandbox_name}/conda/_pkgs
env HISTFILE=€{HOME}/.cache/pysandbox-€{sandbox_name}/.shell_history

# needs a directory that is able to execute files, .cache (default) is not that
env PRE_COMMIT_HOME=€{env_dir}/pre-commit-home

### Work directory
#
# You need to specify the directories that are read+write. Note that malicious
# software will try to do cross-contamination so it is best to have few
# specific writable directory per sandbox only. In this case only the
# working directory + python environment directory - both specific to the
# sandbox environment.
#
mkdir €{env_dir}/€{sandbox_name}
mkdir €{env_dir}/€{sandbox_name}/conda
whitelist €{env_dir}/€{sandbox_name}
whitelist €{working_dir}
private-cwd €{working_dir}