rda-python-setuid 1.0.4__tar.gz → 1.0.6__tar.gz

{rda_python_setuid-1.0.4/src/rda_python_setuid.egg-info → rda_python_setuid-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_setuid
-Version: 1.0.4
+Version: 1.0.6
 Summary: RDA Python Package to setuid for program executions as an effective or common user
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-setuid
@@ -52,7 +52,7 @@ prefix:
 ```
 
 `pip install` then places `setuid_dsarch` in the environment's `bin/` directory
-automatically.  `pywrapper-install --link` locks it down to `chmod 700` so users
+automatically.  `pywrapper-install -l/--link` locks it down to `chmod 700` so users
 cannot bypass the setuid wrapper by running it directly.
 
 ## Environment setup
@@ -91,13 +91,13 @@ pywrapper-install
 pip install rda_python_dsarch
 
 # 2. Compile pywrapper C binary (once per environment):
-pywrapper-install --user gdexdata
+pywrapper-install
 
 # 3. Wire up each program as a setuid entry:
-pywrapper-install --link dsarch --user gdexdata
+pywrapper-install -l dsarch
 
 # 4. Optionally, allow a specialist to run commands as themselves:
-pywrapper-install --pgstart --user zji
+pywrapper-install -p -u zji
 ```
 
 ### Simple install (no sudo required, runs as current user)
@@ -107,7 +107,7 @@ direct symlink from `dsarch` to `setuid_dsarch`:
 
 ```bash
 pip install rda_python_dsarch
-pywrapper-install --link dsarch --simple
+pywrapper-install -l dsarch -s
 ```
 
 ## Runtime flow

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/README.md

@@ -36,7 +36,7 @@ prefix:
 ```
 
 `pip install` then places `setuid_dsarch` in the environment's `bin/` directory
-automatically.  `pywrapper-install --link` locks it down to `chmod 700` so users
+automatically.  `pywrapper-install -l/--link` locks it down to `chmod 700` so users
 cannot bypass the setuid wrapper by running it directly.
 
 ## Environment setup
@@ -75,13 +75,13 @@ pywrapper-install
 pip install rda_python_dsarch
 
 # 2. Compile pywrapper C binary (once per environment):
-pywrapper-install --user gdexdata
+pywrapper-install
 
 # 3. Wire up each program as a setuid entry:
-pywrapper-install --link dsarch --user gdexdata
+pywrapper-install -l dsarch
 
 # 4. Optionally, allow a specialist to run commands as themselves:
-pywrapper-install --pgstart --user zji
+pywrapper-install -p -u zji
 ```
 
 ### Simple install (no sudo required, runs as current user)
@@ -91,7 +91,7 @@ direct symlink from `dsarch` to `setuid_dsarch`:
 
 ```bash
 pip install rda_python_dsarch
-pywrapper-install --link dsarch --simple
+pywrapper-install -l dsarch -s
 ```
 
 ## Runtime flow

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rda_python_setuid"
-version = "1.0.4"
+version = "1.0.6"
 authors = [
   { name="Zaihua Ji", email="zji@ucar.edu" },
 ]

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/src/rda_python_setuid/install.py

@@ -12,16 +12,16 @@
 #
 # Usage:
 #   # 1. Compile and install pywrapper (run once per environment):
-#   pywrapper-install --user gdexdata [--envhome $ENVHOME/bin/]
+#   pywrapper-install [-u gdexdata] [-e $ENVHOME]
 #
 #   # 2. Create pgstart_USER entry so USER can run commands as themselves:
-#   pywrapper-install --pgstart --user zji [--envhome $ENVHOME/bin/]
+#   pywrapper-install -p [-u zji] [-e $ENVHOME]
 #
 #   # 3. Create a symlink so a program runs as CommonUser via pywrapper (setuid):
-#   pywrapper-install --link myprog --user gdexdata [--envhome $ENVHOME/bin/]
+#   pywrapper-install -l myprog [-u gdexdata] [-e $ENVHOME]
 #
 #   # 4. Simple install: symlink PROGRAM -> setuid_PROGRAM (no setuid, runs as current user):
-#   pywrapper-install --link myprog --simple [--envhome $ENVHOME/bin/]
+#   pywrapper-install -l myprog -s [-e $ENVHOME]
 #
 # Convention for wrapped programs:
 #   The target package must register its connector entry point with a setuid_ prefix:
@@ -72,24 +72,24 @@ def main():
       description="Compile and install the pywrapper setuid C binary."
    )
    parser.add_argument(
-      '--envhome', default=None,
-      help="Path to the venv bin/ directory (default: bin/ dir of the current Python executable)"
+      '-e', '--envhome', default=None,
+      help="Path to the venv root directory containing bin/ (default: parent of the current Python executable's bin/ dir)"
    )
    parser.add_argument(
-      '--user', default=None,
-      help="User name to own the setuid binary (default: current login user for --pgstart, gdexdata otherwise)"
+      '-u', '--user', default=None,
+      help="User name to own the setuid binary (default: current login user for -p/--pgstart, gdexdata otherwise)"
    )
    parser.add_argument(
-      '--simple', action='store_true',
-      help="Simple install: create symlink PROGRAM -> setuid_PROGRAM, skipping setuid (use with --link)"
+      '-s', '--simple', action='store_true',
+      help="Simple install: create symlink PROGRAM -> setuid_PROGRAM, skipping setuid (use with -l/--link)"
    )
    group = parser.add_mutually_exclusive_group()
    group.add_argument(
-      '--pgstart', action='store_true',
+      '-p', '--pgstart', action='store_true',
       help="Create pgstart_USER for running commands as USER (Mode 2)"
    )
    group.add_argument(
-      '--link', metavar='PROGRAM',
+      '-l', '--link', metavar='PROGRAM',
       help="Create symlink PROGRAM -> pywrapper for running a fixed program as CommonUser (Mode 1)"
    )
    args = parser.parse_args()
@@ -101,7 +101,7 @@ def main():
       else:
          args.user = 'gdexdata'
 
-   bindir = args.envhome or get_bindir()
+   bindir = os.path.join(args.envhome, 'bin') if args.envhome else get_bindir()
    pywrapper = os.path.join(bindir, 'pywrapper')
 
    if args.link:

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/src/rda_python_setuid/install.usg

@@ -2,34 +2,35 @@
  that execute Python scripts as a common or effective user via the setuid mechanism.
  Must be run inside the target Python virtual environment.
 
- Usage: pywrapper-install --user USER [--envhome BINDIR] [--pgstart | --link PROGRAM [--simple]]
+ Usage: pywrapper-install [-u USER] [-e ENVHOME] [-p | -l PROGRAM [-s]]
 
-      - Option --user USER
+      - Option -u or --user USER
           The user name to own the setuid binary.  For Mode 1 (CommonUser program),
           this is the common user (e.g. gdexdata).  For Mode 2 (pgstart), this is
-          the specialist user (e.g. zji).  Defaults to 'gdexdata' unless --pgstart
+          the specialist user (e.g. zji).  Defaults to 'gdexdata' unless -p/--pgstart
           is given, in which case it defaults to the current login user.
 
-      - Option --envhome BINDIR
-          Path to the venv bin/ directory.  Defaults to the bin/ directory of the
-          currently active Python executable.  Only needed when installing into an
-          environment other than the one currently active.
+      - Option -e or --envhome ENVHOME
+          Path to the venv root directory (the parent of bin/).  Defaults to the
+          parent of the currently active Python executable's bin/ directory.
+          Only needed when installing into an environment other than the one
+          currently active.
 
-      - Option --pgstart
+      - Option -p or --pgstart
           Mode 2: copy the compiled pywrapper binary to pgstart_USER (owned by USER,
           chmod 4750).  Allows USER to run arbitrary commands as themselves via the
-          setuid wrapper.  Cannot be combined with --link.
+          setuid wrapper.  Cannot be combined with -l/--link.
 
-      - Option --link PROGRAM
+      - Option -l or --link PROGRAM
           Mode 1: create a symlink PROGRAM -> pywrapper in the bin/ directory, then
           lock down setuid_PROGRAM (chmod 700, owned by USER) so users cannot bypass
           the setuid wrapper by running setuid_PROGRAM directly.  Cannot be combined
-          with --pgstart.
+          with -p/--pgstart.
 
-      - Option --simple (use with --link)
+      - Option -s or --simple (use with -l/--link)
           Simple install: create a symlink PROGRAM -> setuid_PROGRAM directly,
           skipping the setuid mechanism entirely.  The program runs as the current
-          user with no privilege change.  --user is not required with this option.
+          user with no privilege change.  -u/--user is not required with this option.
           Useful for users who do not need or cannot set up the setuid wrapper.
 
  When run without --pgstart or --link, the default action is to compile pywrapper.c
@@ -98,13 +99,13 @@
          pip install rda_python_dsarch
 
    2. Compile pywrapper (once per environment):
-         pywrapper-install --user gdexdata
+         pywrapper-install
 
    3. Wire up each program as a setuid entry:
-         pywrapper-install --link dsarch --user gdexdata
+         pywrapper-install -l dsarch
 
    4. Optionally, allow a specialist to run commands as themselves:
-         pywrapper-install --pgstart --user zji
+         pywrapper-install -p
 
    Option B - Simple install (no sudo required, runs as current user):
 
@@ -112,21 +113,21 @@
          pip install rda_python_dsarch
 
    2. Create a direct symlink to the connector script:
-         pywrapper-install --link dsarch --simple
+         pywrapper-install -l dsarch -s
 
  Examples:
 
-   1. Compile and install pywrapper for common user gdexdata:
-         pywrapper-install --user gdexdata
+   1. Compile and install pywrapper for common user gdexdata (default):
+         pywrapper-install
 
    2. Same, but targeting a specific environment:
-         pywrapper-install --user gdexdata --envhome /glade/u/home/gdexdata/gdexmsenv/bin/
+         pywrapper-install -e /glade/u/home/gdexdata/gdexmsenv
 
    3. Wire up dsarch to run as gdexdata via pywrapper:
-         pywrapper-install --link dsarch --user gdexdata
+         pywrapper-install -l dsarch
 
    4. Allow specialist zji to run commands as themselves via pgstart:
-         pywrapper-install --pgstart --user zji
+         pywrapper-install -p -u zji
 
    5. Simple install of dsarch for a user who does not need setuid:
-         pywrapper-install --link dsarch --simple
+         pywrapper-install -l dsarch -s

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/src/rda_python_setuid/pgstart.py

@@ -19,26 +19,38 @@ import sys
 import re
 import pwd
 import subprocess
-from rda_python_common import PgLOG
+from rda_python_common.pg_log import PgLOG
 
-#
-# main function to excecute this script
-#
 def main():
+   """Entry point for pgstart.
+
+   Checks whether the real user is authorized (must be the effective user or
+   the GDEX common user), then executes the supplied command as the effective
+   user.  Supports foreground/background execution and optional working-directory
+   change via command-line options.
 
+   Options (prefix with '-'):
+      bg   -- run command in background (non-blocking)
+      fg   -- run command in foreground (default, no-op flag)
+      cwd  -- change to the next argument as working directory before running
+      env  -- print environment variables and exit
+      inc  -- print sys.path include paths and exit
+      plg  -- print PGLOG variables and exit
+   """
+   pglog = PgLOG()
    permit = False
-   PgLOG.PGLOG['LOGFILE'] = "pgstart.log"
+   pglog.PGLOG['LOGFILE'] = "pgstart.log"
    aname = PgLOG.get_command()
-   bckgrd = ""
+   bckgrd = False
    workdir = None
    argv = sys.argv[1:]
 
-   ruid = PgLOG.PGLOG['RUID']
-   euid = PgLOG.PGLOG['EUID']
+   ruid = pglog.PGLOG['RUID']
+   euid = pglog.PGLOG['EUID']
    ruser = pwd.getpwuid(ruid).pw_name
    euser = pwd.getpwuid(euid).pw_name
-   if ruser == euser or ruser == PgLOG.PGLOG['GDEXUSER']: permit = True
-   PgLOG.set_suid(euid)
+   if ruser == euser or ruser == pglog.PGLOG['GDEXUSER']: permit = True
+   pglog.set_suid(euid)
 
    while argv:
       ms = re.match(r'^-(\w+)$', argv[0])
@@ -46,40 +58,43 @@ def main():
       argv.pop(0)
       opt = ms.group(1)
       if opt == "bg":
-         bckgrd = " &"
+         bckgrd = True
       elif opt == "cwd":
          if argv: workdir = argv.pop(0)
       elif opt != "fg":
-         display_message(opt)
+         display_message(pglog, opt)
 
    if not (permit and argv):
       print("********************************************************************")
       print("* Your Login Name is {}({}) & Effective User Name is {}({}).".format(ruser, ruid, euser, euid))
-      print("* Pass a command or options -(plg|env|inc) to run '{}'.".format(aname))
+      print("* Pass a command or options -(bg|fg|cwd|env|inc|plg) to run '{}'.".format(aname))
       if not permit:
-         print("* You must be '{}' or '{}' to execute a command as user '{}'.".format(euser, PgLOG.PGLOG['GDEXUSER'], euser))
+         print("* You must be '{}' or '{}' to execute a command as user '{}'.".format(euser, pglog.PGLOG['GDEXUSER'], euser))
       print("********************************************************************")
       sys.exit(0)
 
-   cmd = PgLOG.argv_to_string(argv)
+   cmd = pglog.argv_to_string(argv)
 
-   msg = "{}-{}{}-{}".format(PgLOG.PGLOG['HOSTNAME'], aname, PgLOG.current_datetime(), PgLOG.PGLOG['CURUID'])
+   msg = "{}-{}{}-{}".format(pglog.PGLOG['HOSTNAME'], aname, pglog.current_datetime(), pglog.PGLOG['CURUID'])
    if workdir:
       msg += "-" + workdir
       os.chdir(workdir)
 
-   PgLOG.pglog("{}: {}".format(msg, cmd), PgLOG.MSGLOG)
+   pglog.pglog("{}: {}".format(msg, cmd), PgLOG.MSGLOG)
    if bckgrd:
       subprocess.Popen(argv)
    else:
       subprocess.run(argv)
    sys.exit(0)
 
-#
-#  display message acording to the option passed in
-#
-def display_message(option):
+def display_message(pglog, option):
+   """Print diagnostic information for the given option and exit.
 
+   Args:
+      pglog (PgLOG): Initialized PgLOG instance.
+      option (str): One of 'env' (environment variables), 'inc' (sys.path),
+                    or 'plg' (PGLOG dict).  Prints an error for unknown values.
+   """
    if option == "env":
       print("Environment Variables:")
       for ename in sorted(os.environ):
@@ -90,8 +105,8 @@ def display_message(option):
          print(pname)
    elif option == "plg":
       print("PGLOG variables:")
-      for vname in sorted(PgLOG.PGLOG):
-         print("{}: {}".format(vname, PgLOG.PGLOG[vname]))
+      for vname in sorted(pglog.PGLOG):
+         print("{}: {}".format(vname, pglog.PGLOG[vname]))
    else:
       print("* {}: Unknown option".format(option))
 

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/src/rda_python_setuid/pywrapper.c

@@ -10,22 +10,22 @@
  *    python -m pip install rda_python_setuid
  *
  *    # Compile pywrapper and set setuid bit (owned by CommonUser):
- *    pywrapper-install --user CommonUser [--envhome $ENVHOME/bin]
+ *    pywrapper-install [-u CommonUser] [-e $ENVHOME/bin]
  *
- *    # For an existing python program, $ENVHOME/bin/CommonProgram.py, to execute it
+ *    # For an existing python program, $ENVHOME/bin/setuid_CommonProgram, to execute it
  *    # as the common user (Mode 1 - symlink):
- *    pywrapper-install --link CommonProgram [--envhome $ENVHOME/bin]
+ *    pywrapper-install -l CommonProgram [-u CommonUser] [-e $ENVHOME/bin]
  *    CommonProgram [options]
  *
  *    # For a specialist to run commands as themselves via pgstart (Mode 2):
- *    pywrapper-install --pgstart --user EffectUser [--envhome $ENVHOME/bin]
+ *    pywrapper-install -p [-u EffectUser] [-e $ENVHOME/bin]
  *    pgstart_EffectUser EffectProgram [options]
  *
  *           N: python 3 release number, it is 10 for Python 3.10.12
  *  CommonUser: a common user login name, such as gdexdata, for GDEXMS configuration
  *  EffectUser: any user login name in the same group of the common user
- *    $ENVHOME: /glade/u/home/gdexdata/rdamsenv (venv) on DECS machines, and
- *              /glade/work/gdexdata/conda-envs/pg-rda (conda) on DAV
+ *    $ENVHOME: /glade/u/home/gdexdata/gdexmsenv (venv) on DECS machines, and
+ *              /glade/work/gdexdata/conda-envs/pg-gdex (conda) on DAV
  *
  * Convention:
  *    Any Python package whose program is to be run via pywrapper must register
@@ -34,7 +34,7 @@
  *       "setuid_dsarch" = "rda_python_dsarch.dsarch:main"
  *    pip install places setuid_dsarch in $ENVHOME/bin/.  pywrapper locates it by
  *    prepending setuid_ to the invoked program name.  No manual script creation needed.
- *    pywrapper-install --link will chown setuid_dsarch to CommonUser and chmod 700,
+ *    pywrapper-install -l/--link will chown setuid_dsarch to CommonUser and chmod 700,
  *    preventing direct execution by other users while still allowing pywrapper
  *    (which runs with EUID=CommonUser via the setuid bit) to execv it.
  *

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6}/src/rda_python_setuid/pywrapper.py

@@ -17,15 +17,23 @@
 import os
 import sys
 import pwd
-from rda_python_common import PgLOG
+from rda_python_common.pg_log import PgLOG
 
-#
-# main function to excecute this script
-#
 def main():
+   """Entry point for setuid_pywrapper (the default pywrapper.c fallback target).
+
+   When pywrapper.c cannot find a matching setuid_<program> entry point, it
+   falls back to executing this script.  Prints UID information and setup
+   instructions, or dumps diagnostic information when a flag is supplied.
 
-   PgLOG.set_suid(PgLOG.PGLOG['EUID'])
-   inc = 1
+   Options:
+      -env  -- print environment variables and exit
+      -inc  -- print sys.path include paths and exit
+      -plg  -- print PGLOG variables and exit
+   """
+   pglog = PgLOG()
+   pglog.set_suid(pglog.PGLOG['EUID'])
+   inc = True
    print("********************************************************************")
    argv = sys.argv[1:]
    if argv:
@@ -33,35 +41,37 @@ def main():
          print("Environment Variables:")
          for ename in sorted(os.environ):
             print("{}: {}".format(ename, os.environ[ename]))
-         inc = 0
+         inc = False
       elif argv[0] == "-inc":
          print("Including Paths:")
          for pname in sorted(sys.path):
             print(pname)
-         inc = 0
+         inc = False
       elif argv[0] == "-plg":
          print("PGLOG variables:")
-         for vname in sorted(PgLOG.PGLOG):
-            print("{}: {}".format(vname, PgLOG.PGLOG[vname]))
-         inc = 0
+         for vname in sorted(pglog.PGLOG):
+            print("{}: {}".format(vname, pglog.PGLOG[vname]))
+         inc = False
       else:
          print("* {}: Unknown option".format(argv[0]))
    else:
-      ruid = PgLOG.PGLOG['RUID']
-      euid = PgLOG.PGLOG['EUID']
+      ruid = pglog.PGLOG['RUID']
+      euid = pglog.PGLOG['EUID']
       ruser = pwd.getpwuid(ruid).pw_name
       euser = pwd.getpwuid(euid).pw_name
-      print("* Your Login Name is {}({}) & Effective User Name is {}({}).".format(ruser, ruid, euser,euid))
-      print("* To wrap your python script 'yourscript.py', you install it as")
-      print("* an executable under $ENVHOME/bin/ and create a link to 'pywrapper'")
-      print("* under $ENVHOME/bin/ as 'ln -s pywrapper yourscript'.")
+      print("* Your Login Name is {}({}) & Effective User Name is {}({}).".format(ruser, ruid, euser, euid))
+      print("* To wrap a Python program 'yourscript', register its entry point")
+      print("* with a setuid_ prefix in pyproject.toml:")
+      print("*    [project.scripts]")
+      print("*    \"setuid_yourscript\" = \"your_package.module:main\"")
+      print("* Then run: pywrapper-install -l yourscript")
    if inc:
       print("* Include -env to show environment variables")
       print("* Include -inc to show included paths")
       print("* Include -plg to show PGLOG variables")
-   
+
    print("********************************************************************\n")
-   
+
    sys.exit(0)
 
 #

{rda_python_setuid-1.0.4 → rda_python_setuid-1.0.6/src/rda_python_setuid.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_setuid
-Version: 1.0.4
+Version: 1.0.6
 Summary: RDA Python Package to setuid for program executions as an effective or common user
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-setuid
@@ -52,7 +52,7 @@ prefix:
 ```
 
 `pip install` then places `setuid_dsarch` in the environment's `bin/` directory
-automatically.  `pywrapper-install --link` locks it down to `chmod 700` so users
+automatically.  `pywrapper-install -l/--link` locks it down to `chmod 700` so users
 cannot bypass the setuid wrapper by running it directly.
 
 ## Environment setup
@@ -91,13 +91,13 @@ pywrapper-install
 pip install rda_python_dsarch
 
 # 2. Compile pywrapper C binary (once per environment):
-pywrapper-install --user gdexdata
+pywrapper-install
 
 # 3. Wire up each program as a setuid entry:
-pywrapper-install --link dsarch --user gdexdata
+pywrapper-install -l dsarch
 
 # 4. Optionally, allow a specialist to run commands as themselves:
-pywrapper-install --pgstart --user zji
+pywrapper-install -p -u zji
 ```
 
 ### Simple install (no sudo required, runs as current user)
@@ -107,7 +107,7 @@ direct symlink from `dsarch` to `setuid_dsarch`:
 
 ```bash
 pip install rda_python_dsarch
-pywrapper-install --link dsarch --simple
+pywrapper-install -l dsarch -s
 ```
 
 ## Runtime flow