Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

utils: T7095: make vrf and netns arguments aware of the shell #4323

Open
wants to merge 3 commits into
base: current
Choose a base branch
from
Open

utils: T7095: make vrf and netns arguments aware of the shell #4323

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb546cb
utils: T7095: remove unused `auth` parameter
xeluior Jan 27, 2025
a24d2f8
utils: T7095: make wrapper use_shell aware and only utilize if vrf or…
xeluior Jan 27, 2025
f400eec
Merge branch 'current' into T7095_vrf-fix
xeluior Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions python/vyos/utils/process.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,25 @@
# License along with this library. If not, see <http://www.gnu.org/licenses/>.

import os
import shlex

from subprocess import Popen
from subprocess import PIPE
from subprocess import STDOUT
from subprocess import DEVNULL


def get_wrapper(vrf, netns, auth):
wrapper = ''
def get_wrapper(vrf, netns):
wrapper = None
if vrf:
wrapper = f'ip vrf exec {vrf} '
wrapper = ['ip', 'vrf', 'exec', vrf]
elif netns:
wrapper = f'ip netns exec {netns} '
if auth:
wrapper = f'{auth} {wrapper}'
wrapper = ['ip', 'netns', 'exec', netns]
return wrapper


def popen(command, flag='', shell=None, input=None, timeout=None, env=None,
stdout=PIPE, stderr=PIPE, decode='utf-8', auth='', vrf=None,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to drop the auth argument?

netns=None):
stdout=PIPE, stderr=PIPE, decode='utf-8', vrf=None, netns=None):
"""
popen is a wrapper helper around subprocess.Popen
with it default setting it will return a tuple (out, err)
Expand Down Expand Up @@ -75,28 +73,33 @@ def popen(command, flag='', shell=None, input=None, timeout=None, env=None,
if not debug.enabled(flag):
flag = 'command'

use_shell = shell
stdin = None
if shell is None:
use_shell = False
if ' ' in command:
use_shell = True
if env:
use_shell = True

# Must be run as root to execute command in VRF or network namespace
wrapper = get_wrapper(vrf, netns)
if vrf or netns:
if os.getuid() != 0:
raise OSError(
'Permission denied: cannot execute commands in VRF and netns contexts as an unprivileged user'
)

wrapper = get_wrapper(vrf, netns, auth)
command = f'{wrapper} {command}' if wrapper else command
if use_shell:
command = f'{shlex.join(wrapper)} {command}'
else:
if type(command) is not list:
command = [command]
command = wrapper + command

cmd_msg = f"cmd '{command}'"
cmd_msg = f"cmd '{command}'" if use_shell else f"cmd '{shlex.join(command)}'"
debug.message(cmd_msg, flag)

use_shell = shell
stdin = None
if shell is None:
use_shell = False
if ' ' in command:
use_shell = True
if env:
use_shell = True

if input:
stdin = PIPE
input = input.encode() if type(input) is str else input
Expand Down Expand Up @@ -155,7 +158,7 @@ def run(command, flag='', shell=None, input=None, timeout=None, env=None,

def cmd(command, flag='', shell=None, input=None, timeout=None, env=None,
stdout=PIPE, stderr=PIPE, decode='utf-8', raising=None, message='',
expect=[0], auth='', vrf=None, netns=None):
expect=[0], vrf=None, netns=None):
"""
A wrapper around popen, which returns the stdout and
will raise the error code of a command
Expand All @@ -171,12 +174,11 @@ def cmd(command, flag='', shell=None, input=None, timeout=None, env=None,
input=input, timeout=timeout,
env=env, shell=shell,
decode=decode,
auth=auth,
vrf=vrf,
netns=netns,
)
if code not in expect:
wrapper = get_wrapper(vrf, netns, auth='')
wrapper = get_wrapper(vrf, netns)
command = f'{wrapper} {command}'
feedback = message + '\n' if message else ''
feedback += f'failed to run command: {command}\n'
Expand Down
Loading