Passing arguments to python script?

[LilTrublMakr]

Would anyone be kind enough to point me in the right direction of using the passed arguments in a python script? My Googling skills are not helping. My end goal is to use Netbox as my SoT and to use webhook to pass through arguments to a python script so netmiko can provision the end devices.

[davama]

Just pass the entire payload to your py script.

https://github.com/adnanh/webhook/blob/master/docs/Referencing-Request-Values.md#special-cases

From py perspective, they would be sys.argv[n]

[LilTrublMakr]

python, thankfully well get easier over time.

I sure hope so. I am starting to get aggravated with this project lol.

So I did the exact code as you posted and tried to run the webhook. All I can get to is the output of:

[webhook] 2022/06/30 17:58:43 Started POST /hooks/test
[webhook] 2022/06/30 17:58:43 [7ecfe8] incoming HTTP request from 192.168.0.150:37522
[webhook] 2022/06/30 17:58:43 [7ecfe8] test got matched
[webhook] 2022/06/30 17:58:43 [7ecfe8] test hook triggered successfully
[webhook] 2022/06/30 17:58:43 [7ecfe8] executing /home/tftp/netmiko/test.py (/home/tftp/netmiko/test.py) with arguments ["/home/tftp/netmiko/test.py" "[JSON TRUNCATED]"] and environment [] using /home/tftp/netmiko as cwd
[webhook] 2022/06/30 17:58:43 [7ecfe8] command output:
[webhook] 2022/06/30 17:58:43 [7ecfe8] error occurred: fork/exec /home/tftp/netmiko/test.py: exec format error
[webhook] 2022/06/30 17:58:43 [7ecfe8] finished handling test
[webhook] 2022/06/30 17:58:43 Completed 500 Internal Server Error in 10.611993ms

I read that it might be a permissions issue but I chmodded all of the files to 777. Permissions of /home/tftp/netmiko/:

tftp@tftp:~/netmiko$ ls -l
total 16
-rwxrwxrwx 1 root root  355 Jun 30 17:58 test.py
-rwxrwxrwx 1 root root 1155 Jun 30 17:49 unifi.py

This is running on Ubuntu Server 20.04.

[davama]

Not sure what you did ... but I just whipped it up and it works.

two things of note:

you must add an interpreter to the very top of the script:

#!/usr/bin/env python

import sys
import json
...
...

And you must have the script executable chmod +x script

my results:

> curl -k -d '{"my":"payload"}' https://webhook.bla.bla/spit_my_payload
{'{"my":"payload"}': ''}

The logs:

[webhook] 2022/06/30 19:00:15 [a0fb97] incoming HTTP POST request from 172.18.0.1:38494
[webhook] 2022/06/30 19:00:15 [a0fb97] spit_my_payload got matched
[webhook] 2022/06/30 19:00:15 [a0fb97] spit_my_payload hook triggered successfully
[webhook] 2022/06/30 19:00:15 [a0fb97] executing /etc/webhook/netbox/spit_my_payload.py (/etc/webhook/netbox/spit_my_payload.py) with arguments ["/etc/webhook/netbox/spit_my_payload.py" "{\"Accept\":\"*/*\",\"Content-Length\":\"16\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"curl/7.61.1\",\"X-Forwarded-For\":\"10.x.x.x\",\"X-Forwarded-Host\":\"webhook.bla.bla\",\"X-Forwarded-Proto\":\"https\",\"X-Forwarded-Ssl\":\"on\",\"X-Forwarded-Uri\":\"/spit_my_payload\",\"X-Real-Ip\":\"10.x.x.x\"}" "{\"{\\\"my\\\":\\\"payload\\\"}\":\"\"}"] and environment [] using /etc/webhook as cwd
[webhook] 2022/06/30 19:00:16 [a0fb97] command output: {'{"my":"payload"}': ''}

[webhook] 2022/06/30 19:00:16 [a0fb97] finished handling spit_my_payload
[webhook] 2022/06/30 19:00:16 [a0fb97] 200 | 25 B | 78.149431ms | webhook.bla.bla | POST /spit_my_payload

Regarding your script, I would start basic and slowly build.

[LilTrublMakr]

One step closer... Added the shebang #!/usr/bin python3 (yay Ubuntu) and now I am getting a permission denied message.

[webhook] 2022/06/30 21:15:08 Started POST /hooks/test
[webhook] 2022/06/30 21:15:08 [a1fba4] incoming HTTP request from 127.0.0.1:49682
[webhook] 2022/06/30 21:15:08 [a1fba4] test got matched
[webhook] 2022/06/30 21:15:08 [a1fba4] test hook triggered successfully
[webhook] 2022/06/30 21:15:08 [a1fba4] executing /home/tftp/netmiko/test.py (/home/tftp/netmiko/test.py) with arguments ["/home/tftp/netmiko/test.py" "{\"Accept\":\"*/*\",\"Content-Length\":\"44\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"curl/7.68.0\"}" "{\"{\\\"my\\\":\\\"payload\\\", \\\"will\\\":\\\"it\\\", \\\"work\\\":\\\"nope\\\"}\":\"\"}"] and environment [] using /home/tftp/netmiko as cwd
[webhook] 2022/06/30 21:15:08 [a1fba4] command output:
[webhook] 2022/06/30 21:15:08 [a1fba4] error occurred: fork/exec /home/tftp/netmiko/test.py: permission denied
[webhook] 2022/06/30 21:15:08 [a1fba4] finished handling test
[webhook] 2022/06/30 21:15:08 Completed 500 Internal Server Error in 21.315526ms

The file does have execute permission as shown in my last post so I am unsure why the script is not being allowed to run...

I am also unsure why all of the "\"s are getting added. The code I am running is curl -k -d '{"my":"payload", "will":"it", "work":"nope"}' 127.0.0.1:9000/hooks/test

[davama]

Thats interesting

i would check permissions on your directories.
Or place the scripts at the same level as your webhook files.

you have a docker-compose file or dockerfile to show?

[LilTrublMakr]

No, I am not using docker in this instance except for Netbox which is on another machine and shouldn't be a factor. I moved the python to the same folder and I am still getting permissions issues. I am moving everything to a new folder that is outside of the home directory to see if that does anything. Worst case scenario, I have a Raspberry Pi that I can turn in to a webhook server.

EDIT: So I changed to a sh script to test the webhook and the sh script works as it should. It seems to only be python scripts that can not be run. Permissions match between both files.

Permissions:

tftp@tftp:/mnt/netmiko$ ls -l
total 8
-rwxr-xr-x 1 root root 365 Jun 30 23:02 test.py
-rwxr-xr-x 1 root root  32 Jun 30 23:45 test.sh

webhook output:

[webhook] 2022/07/01 00:00:10 Started POST /hooks/test
[webhook] 2022/07/01 00:00:10 [41401d] incoming HTTP request from 127.0.0.1:58164
[webhook] 2022/07/01 00:00:10 [41401d] test got matched
[webhook] 2022/07/01 00:00:10 [41401d] test hook triggered successfully
[webhook] 2022/07/01 00:00:10 [41401d] executing /mnt/netmiko/test.sh (/mnt/netmiko/test.sh) with arguments ["/mnt/netmiko/test.sh" "{\"Accept\":\"*/*\",\"Content-Length\":\"44\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"curl/7.68.0\"}" "{\"{\\\"my\\\":\\\"payload\\\", \\\"will\\\":\\\"it\\\", \\\"work\\\":\\\"nope\\\"}\":\"\"}"] and environment [] using /mnt/netmiko as cwd
[webhook] 2022/07/01 00:00:10 [41401d] command output: test complete
[webhook] 2022/07/01 00:00:10 [41401d] finished handling test
[webhook] 2022/07/01 00:00:10 Completed 200 OK in 4.513119ms

[webhook] 2022/07/01 00:00:48 hooks file hooks.json modified
[webhook] 2022/07/01 00:00:48 attempting to reload hooks from hooks.json
[webhook] 2022/07/01 00:00:48 found 1 hook(s) in file
[webhook] 2022/07/01 00:00:48   loaded: test

[webhook] 2022/07/01 00:00:59 Started POST /hooks/test
[webhook] 2022/07/01 00:00:59 [6244c2] incoming HTTP request from 127.0.0.1:58166
[webhook] 2022/07/01 00:00:59 [6244c2] test got matched
[webhook] 2022/07/01 00:00:59 [6244c2] test hook triggered successfully
[webhook] 2022/07/01 00:00:59 [6244c2] executing /mnt/netmiko/test.py (/mnt/netmiko/test.py) with arguments ["/mnt/netmiko/test.py" "{\"Accept\":\"*/*\",\"Content-Length\":\"44\",\"Content-Type\":\"application/x-www-form-urlencoded\",\"User-Agent\":\"curl/7.68.0\"}" "{\"{\\\"my\\\":\\\"payload\\\", \\\"will\\\":\\\"it\\\", \\\"work\\\":\\\"nope\\\"}\":\"\"}"] and environment [] using /mnt/netmiko as cwd
[webhook] 2022/07/01 00:00:59 [6244c2] command output:
[webhook] 2022/07/01 00:00:59 [6244c2] error occurred: fork/exec /mnt/netmiko/test.py: permission denied
[webhook] 2022/07/01 00:00:59 [6244c2] finished handling test
[webhook] 2022/07/01 00:00:59 Completed 500 Internal Server Error in 2.156632ms

EDIT2: Well... Case of 'walk away and try again with fresh eyes...'
#!/usr/bin python3
/facepalm