example

README

shell hook example

You can either build the example yourself or run the provided dockerfile at the repository root.

Docker

From the root of the repository:

powershell example

docker build -f Dockerfile.powershell .

bash example

docker build -f Dockerfile.bash .

Build

bash

# from the root of the repo
mkdir -p dist
mkdir -p /app
go build -o dist/example cmd/example/main.go
chmod +x dist/example
cp dist/example /app/

powershell (linux)

# from the root of the repo
mkdir ./dist -Force
mkdir /app -Force
go build -o dist/example cmd/example/main.go
copy dist/example /app/

Setup

bash

# add executable to path
echo 'eval PATH=$PATH:/app' >> ~/.bashrc
# invoke the hook script
echo 'eval "$(example hook bash)"' >> ~/.bashrc

powershell

# create profile if it does not exist
if (!(Test-Path -Path $PROFILE)) { 
  New-Item -ItemType File -Path $PROFILE -Force
}
# append to path
write-output '$env:PATH += [IO.Path]::PathSeparator + "/app"' >> $PROFILE
# invoke the hook script
write-output 'iex $(example hook powershell | Out-String)' >> $PROFILE

Test

After installing you can see if the example is working by looking at environment variables. The example will inject the "SHELLHOOK" environment variable.

If you chose the dockerfile option, you can run the image interactively using docker run -it --rm <imageid> where imageid is the id of the built image.

bash

printenv

HOSTNAME=ae33849307dd
PWD=/
HOME=/root
LS_COLORS=rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:mi=00:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:*.tar=01;31:*.tgz=01;31:*.arc=01;31:*.arj=01;31:*.taz=01;31:*.lha=01;31:*.lz4=01;31:*.lzh=01;31:*.lzma=01;31:*.tlz=01;31:*.txz=01;31:*.tzo=01;31:*.t7z=01;31:*.zip=01;31:*.z=01;31:*.dz=01;31:*.gz=01;31:*.lrz=01;31:*.lz=01;31:*.lzo=01;31:*.xz=01;31:*.zst=01;31:*.tzst=01;31:*.bz2=01;31:*.bz=01;31:*.tbz=01;31:*.tbz2=01;31:*.tz=01;31:*.deb=01;31:*.rpm=01;31:*.jar=01;31:*.war=01;31:*.ear=01;31:*.sar=01;31:*.rar=01;31:*.alz=01;31:*.ace=01;31:*.zoo=01;31:*.cpio=01;31:*.7z=01;31:*.rz=01;31:*.cab=01;31:*.wim=01;31:*.swm=01;31:*.dwm=01;31:*.esd=01;31:*.jpg=01;35:*.jpeg=01;35:*.mjpg=01;35:*.mjpeg=01;35:*.gif=01;35:*.bmp=01;35:*.pbm=01;35:*.pgm=01;35:*.ppm=01;35:*.tga=01;35:*.xbm=01;35:*.xpm=01;35:*.tif=01;35:*.tiff=01;35:*.png=01;35:*.svg=01;35:*.svgz=01;35:*.mng=01;35:*.pcx=01;35:*.mov=01;35:*.mpg=01;35:*.mpeg=01;35:*.m2v=01;35:*.mkv=01;35:*.webm=01;35:*.webp=01;35:*.ogm=01;35:*.mp4=01;35:*.m4v=01;35:*.mp4v=01;35:*.vob=01;35:*.qt=01;35:*.nuv=01;35:*.wmv=01;35:*.asf=01;35:*.rm=01;35:*.rmvb=01;35:*.flc=01;35:*.avi=01;35:*.fli=01;35:*.flv=01;35:*.gl=01;35:*.dl=01;35:*.xcf=01;35:*.xwd=01;35:*.yuv=01;35:*.cgm=01;35:*.emf=01;35:*.ogv=01;35:*.ogx=01;35:*.aac=00;36:*.au=00;36:*.flac=00;36:*.m4a=00;36:*.mid=00;36:*.midi=00;36:*.mka=00;36:*.mp3=00;36:*.mpc=00;36:*.ogg=00;36:*.ra=00;36:*.wav=00;36:*.oga=00;36:*.opus=00;36:*.spx=00;36:*.xspf=00;36:
SHELLHOOK=TEST
TERM=xterm
SHLVL=1
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/app
_=/usr/bin/printenv

powershell

dir env:/

Name                           Value
----                           -----
DOTNET_SYSTEM_GLOBALIZATION_I… false
HOME                           /root
HOSTNAME                       2a24dbe0c693
LANG                           en_US.UTF-8
LC_ALL                         en_US.UTF-8
PATH                           /opt/microsoft/powershell/7-lts:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/app
POWERSHELL_DISTRIBUTION_CHANN… PSDocker-Ubuntu-22.04
PSModuleAnalysisCachePath      /var/cache/microsoft/powershell/PSModuleAnalysisCache/ModuleAnalysisCache
PSModulePath                   /root/.local/share/powershell/Modules:/usr/local/share/powershell/Modules:/opt/microsoft/powershell/7-lts/Modules     
SHELLHOOK                      TEST
TERM                           xterm