printerxpl-forge 6.2.0__py3-none-any.whl

src/utils/operators.py

@@ -0,0 +1,474 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+PostScript Operators Database
+===============================
+This module contains a comprehensive list of PostScript operators organized by category.
+
+Contains 400+ PostScript operators including:
+- Standard operators (file, exec, run, etc.)
+- Proprietary operators (Brother, HP, etc.)
+- Security-relevant operators for testing
+- 16 categories covering all PS functionality
+
+PLANNED USAGE:
+=======================
+from utils.operators import operators
+
+class ps(printer):
+    def __init__(self, args):
+        super().__init__(args)
+        self.ops = operators()
+        
+    def do_enumerate_operators(self, arg):
+        '''Test which PostScript operators are available'''
+        for category, ops in self.ops.oplist.items():
+            print(f"\\n{category}")
+            for op in ops:
+                result = self.test_operator(op)
+                # Display result
+
+SECURITY TESTING:
+=================
+This module enables testing for:
+- File system access (file, deletefile, renamefile)
+- Code execution (exec, run, cvx)
+- Information disclosure (product, version, serialnumber)
+- Authentication bypass (setpassword, getpassword)
+- Device control (devformat, devmount, devdismount)
+
+DO NOT REMOVE: Required for upcoming PostScript security testing module
+"""
+
+# Author    : Andre Henrique (@mrhenrike)
+# GitHub    : https://github.com/mrhenrike
+# LinkedIn  : https://linkedin.com/in/mrhenrike
+# X/Twitter : https://x.com/mrhenrike
+
+class operators():
+    '''
+    ┌─────────────────────────────────────┐
+    │ PostScript operators and categories │
+    └─────────────────────────────────────┘
+    '''
+    oplist = {
+        '01. Operand Stack Manipulation Operators':
+        [
+            'pop',
+            'exch',
+            'dup',
+            'copy',
+            'index',
+            'roll',
+            'clear',
+            'count',
+            'mark',
+            'cleartomark',
+            'counttomark'
+        ],
+        '02. Arithmetic and Math Operators':
+        [
+            'add',
+            'div',
+            'idiv',
+            'mod',
+            'mul',
+            'sub',
+            'abs',
+            'neg',
+            'ceiling',
+            'floor',
+            'round',
+            'truncate',
+            'sqrt',
+            'atan',
+            'cos',
+            'sin',
+            'exp',
+            'ln',
+            'log',
+            'rand',
+            'srand',
+            'rrand'
+        ],
+        '03. Array Operators':
+        [
+            'array',
+            'length',
+            'get',
+            'put',
+            'getinterval',
+            'putinterval',
+            'astore',
+            'aload',
+            'forall'
+        ],
+        '04. Packed Array Operators':
+        [
+            'packedarray',
+            'setpacking',
+            'currentpacking'
+        ],
+        '05. Dictionary Operators':
+        [
+            'dict ',
+            'maxlength',
+            'begin',
+            'end',
+            'def',
+            'load',
+            'store',
+            'undef',
+            'known',
+            'where',
+            'currentdict',
+            'errordict',
+            '$error',
+            'systemdict',
+            'userdict',
+            'globaldict',
+            'statusdict',
+            'countdictstack',
+            'dictstack',
+            'cleardictstack'
+        ],
+        '06. String Operators':
+        [
+            'string',
+            'anchorsearch',
+            'search'
+        ],
+        '07. Relational, Boolean, and Bitwise Operators':
+        [
+            'eq',
+            'ne',
+            'ge',
+            'gt',
+            'le',
+            'lt',
+            'and',
+            'or',
+            'xor',
+            'true',
+            'false',
+            'bitshift'
+        ],
+        '08. Control Operators':
+        [
+            'exec',
+            'if',
+            'ifelse',
+            'for',
+            'repeat',
+            'loop',
+            'exit',
+            'stop',
+            'stopped',
+            'countexecstack',
+            'execstack',
+            'quit',
+            'start'
+        ],
+        '09. Type, Attribute, and Conversion Operators':
+        [
+            'type',
+            'cvlit',
+            'cvx',
+            'xcheck',
+            'executeonly',
+            'noaccess',
+            'readonly',
+            'rcheck',
+            'wcheck',
+            'cvi',
+            'cvn',
+            'cvr',
+            'cvrs',
+            'cvs'
+        ],
+        '10. File Operators':
+        [
+            'file',
+            'filter',
+            'closefile',
+            'read',
+            'write',
+            'readhexstring',
+            'writehexstring',
+            'readstring',
+            'writestring',
+            'readline',
+            'token',
+            'bytesavailable',
+            'flush',
+            'flushfile',
+            'resetfile',
+            'status',
+            'run',
+            'currentfile',
+            'deletefile',
+            'renamefile',
+            'filenameforall',
+            'setfileposition',
+            'fileposition',
+            'print',
+            '=',
+            '==',
+            'stack',
+            'pstack',
+            'printobject',
+            'writeobject',
+            'setobjectformat',
+            'currentobjectformat'
+        ],
+        '11. Resource Operators':
+        [
+            'defineresource',
+            'undefineresource',
+            'findresource',
+            'findcolorrendering',
+            'resourcestatus',
+            'resourceforall'
+        ],
+        '12. Virtual Memory Operators':
+        [
+            'save',
+            'restore',
+            'setglobal',
+            'currentglobal',
+            'gcheck',
+            'startjob',
+            'defineuserobject',
+            'execuserobject',
+            'undefineuserobject'
+        ],
+        '13. Miscellaneous Operators':
+        [
+            'bind',
+            'null',
+            'version',
+            'realtime',
+            'usertime',
+            'languagelevel',
+            'product',
+            'revision',
+            'serialnumber',
+            'executive',
+            'echo',
+            'prompt'
+        ],
+        '14. Device Setup and Output Operators':
+        [
+            'showpage',
+            'copypage',
+            'setpagedevice',
+            'currentpagedevice',
+            'nulldevice'
+        ],
+        '15. Error Operators':
+        [
+            'handleerror',
+            '.error'
+        ],
+        '16. Supplement and Proprietary Operators':
+        [
+            'BiteMe',
+            'brCIDCode',
+            'brfindfont',
+            'brGetCurrentColor',
+            'brgetjpnfont',
+            '_BRFileExec',
+            '_brGetXPSPage',
+            '_brGetXPSThumb',
+            '_brpdfscan',
+            'brlanguagelevel',
+            'brPchk',
+            'brPDFThumbPrint',
+            'brPSDKey',
+            'BrRegiChart',
+            'brTpForm',
+            'brTpPjlCheck',
+            'brTpStroke',
+            'buildfunction',
+            'buildtime',
+            'byteorder',
+            'cache_memory',
+            'callut',
+            'cexec',
+            'changeucrgcr',
+            'chdir',
+            'checksum',
+            'cidcompat',
+            'clearinterrupt',
+            'command',
+            'composefont',
+            'cwd',
+            'defaultduplexmode',
+            'defaultpapertray',
+            'defaultresolution',
+            'defaulttimeouts',
+            'defaulttrayswitch',
+            'defaulttumble',
+            'devcontrol',
+            'devdismount',
+            'devforall',
+            'devformat',
+            'devmount',
+            'devstatus',
+            'directimage',
+            'disableinterrupt',
+            'discardtransparencygroup',
+            'diskonline',
+            'diskstatus',
+            'displayoperatormsg',
+            'doautoformfeed',
+            'doexecutive',
+            'doffsuppress',
+            'doinitfile',
+            'dopanellock',
+            'dopowersave',
+            'doprinterrors',
+            'doreprint',
+            'dostartpage',
+            'dosysstart',
+            'duplexer',
+            'enableinterrupt',
+            'endjob',
+            'endtransparencygroup',
+            'endtransparencymask',
+            'enginesync',
+            'execdepth',
+            'execn',
+            'execpoolimgtable',
+            'execvecttoimagetable',
+            'findcolorrendering',
+            'firstside',
+            'fontnonzerowinding',
+            'fontprivatedict',
+            'gadget',
+            'getedlut',
+            'getenginedebug',
+            'getentitydir',
+            'getfinelut',
+            'getjobstms',
+            'getmydata',
+            'getpassword',
+            'getsuperfinelut',
+            'gettrue1200',
+            'getufstring',
+            'hardwareiomode',
+            'idle',
+            'idlefonts',
+            'ignoresize',
+            'imagemasksw',
+            'imagetiff',
+            'initializedisk',
+            'initlut',
+            'inittransparencymask',
+            'interrupts_clear',
+            'interrupts_enabled',
+            'interrupts_no',
+            'interrupts_reset',
+            'interrupts_yes',
+            'ipdsjog',
+            'jobtimeout',
+            'kccreatepic',
+            'kcdeletepic',
+            'kcloadpic',
+            'kcmakebarcode',
+            'kcrevivepic',
+            'kcsavepic',
+            'lzwavailable',
+            'malloc_verify',
+            'MD5Encode',
+            'newsheet',
+            'pagecount',
+            'pagesprinted',
+            'panel',
+            'paperdirectional',
+            'papertray',
+            'patternsearch',
+            'pdfnewsheet',
+            'peek',
+            'poke',
+            'powersavetime',
+            'pragmatics',
+            'printconfiguration',
+            'printername',
+            'printer_reset',
+            'printer_status',
+            'processcolors',
+            'processipdserror',
+            'pwd',
+            'ramsize',
+            'rdbytes',
+            'readinputbuffer',
+            'readpbstring',
+            'readtotalramsize',
+            'remain_memory',
+            'removeall',
+            'removeglyphs',
+            'resolveicc',
+            'sccbatch',
+            'sccinteractive',
+            'setbrFilename',
+            'setbrTpBM',
+            'setbrTpca',
+            'setcoverpage',
+            'setdefaultduplexmode',
+            'setdefaultpapertray',
+            'setdefaultresolution',
+            'setdefaulttimeouts',
+            'setdefaulttrayswitch',
+            'setdefaulttumble',
+            'setdoautoformfeed',
+            'setdoffsuppress',
+            'setdopanellock',
+            'setdopowersave',
+            'setdoprinterrors',
+            'setdoreprint',
+            'setdostartpage',
+            'setdosysstart',
+            'setedlut',
+            'setenginesync',
+            'setfilenameextend',
+            'setfillalpha',
+            'setfinelut',
+            'sethardwareiomode',
+            'setignoresize',
+            'setipdsmode',
+            'setjobname',
+            'setjobtimeout',
+            'setmanualduplexmode',
+            'setmediatype',
+            'setpantonescreen',
+            'setpapertray',
+            'setpassword',
+            'setprintername',
+            'setropmode',
+            'setsccbatch',
+            'setsccinteractive',
+            'setsmoothness',
+            'setsoftalpha',
+            'setsoftwareiomode',
+            'setstrokealpha',
+            'setsuperfinelut',
+            'setuniversalsize',
+            'setusbbinary',
+            'setuserdiskpercent',
+            'smooth4',
+            'softwareiomode',
+            'statementnumber',
+            'stretch',
+            'tonersave',
+            'train_memory',
+            'transparencyshowpage',
+            'ucrgcrforimage',
+            'ucrgcrtable600',
+            'ucrgcrtablecapt',
+            'unlimit',
+            'usepantonescreen',
+            'userdiskpercent',
+            'verify'
+        ]  # TBD: reduce to the `interesting' ones (from a security point of view)
+    }

src/utils/ports.py

@@ -0,0 +1,234 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+PrinterXPL-Forge — Port Configuration Utility
+==========================================
+Centralised protocol-to-port mapping with user-override support.
+
+All connection code should call `PortConfig.resolve(protocol)` instead of
+using literal port numbers.  This enables every module to honour custom
+ports supplied by the operator without touching each module individually.
+
+Supported protocol keys (case-insensitive):
+    raw      — RAW/JetDirect/PJL           default 9100
+    ipp      — Internet Printing Protocol  default 631
+    lpd      — LPD/LPR                    default 515
+    snmp     — SNMP                        default 161
+    ftp      — FTP                         default 21
+    http     — HTTP (EWS / web interface)  default 80
+    https    — HTTPS                       default 443
+    smb      — SMB/CIFS                    default 445
+    telnet   — Telnet management           default 23
+    wsd      — WSD (discovery)             default 3702
+
+Usage:
+    # One-time setup (call from main() after parsing args):
+    from utils.ports import PortConfig
+    PortConfig.configure(raw=3910, snmp=1161)
+
+    # In any module:
+    from utils.ports import PortConfig
+    port = PortConfig.resolve('raw')        # returns override or 9100
+    port = PortConfig.resolve('snmp')       # returns override or 161
+    port = PortConfig.resolve('ipp')        # returns override or 631
+
+    # Extra probe ports (added on top of defaults for banner scan):
+    extras = PortConfig.extra_scan_ports()  # set of int
+"""
+# Author    : Andre Henrique (@mrhenrike)
+# GitHub    : https://github.com/mrhenrike
+# LinkedIn  : https://linkedin.com/in/mrhenrike
+# X/Twitter : https://x.com/mrhenrike
+
+from __future__ import annotations
+
+from typing import Dict, FrozenSet, Optional, Set
+
+# ── Protocol defaults ─────────────────────────────────────────────────────────
+
+_DEFAULTS: Dict[str, int] = {
+    'raw':    9100,   # RAW / JetDirect / PJL
+    'ipp':    631,    # Internet Printing Protocol
+    'lpd':    515,    # LPD/LPR
+    'snmp':   161,    # SNMP (UDP)
+    'ftp':    21,     # FTP management
+    'http':   80,     # HTTP embedded web server
+    'https':  443,    # HTTPS embedded web server
+    'smb':    445,    # SMB/CIFS
+    'telnet': 23,     # Telnet management
+    'wsd':    3702,   # WSD / WS-Discovery (UDP)
+}
+
+# Aliases accepted as protocol names
+_ALIASES: Dict[str, str] = {
+    'pjl':       'raw',
+    'jetdirect': 'raw',
+    'print':     'raw',
+    '9100':      'raw',
+    '631':       'ipp',
+    '515':       'lpd',
+    'lpr':       'lpd',
+    '161':       'snmp',
+    '21':        'ftp',
+    '80':        'http',
+    '443':       'https',
+    '445':       'smb',
+    '23':        'telnet',
+    '3702':      'wsd',
+}
+
+
+class PortConfig:
+    """
+    Module-level singleton for protocol port configuration.
+
+    All state is class-level so any module importing this class sees the same
+    overrides without dependency injection.
+    """
+
+    _overrides:    Dict[str, int] = {}   # proto → custom port
+    _extra_ports:  Set[int]       = set()  # additional scan ports
+
+    # ── Configuration (call once from main) ───────────────────────────────────
+
+    @classmethod
+    def configure(cls,
+                  raw:    Optional[int] = None,
+                  ipp:    Optional[int] = None,
+                  lpd:    Optional[int] = None,
+                  snmp:   Optional[int] = None,
+                  ftp:    Optional[int] = None,
+                  http:   Optional[int] = None,
+                  https:  Optional[int] = None,
+                  smb:    Optional[int] = None,
+                  telnet: Optional[int] = None,
+                  wsd:    Optional[int] = None,
+                  extra:  Optional[Set[int]] = None) -> None:
+        """
+        Set custom ports for one or more protocols.
+
+        Args:
+            raw:    Override RAW/PJL/JetDirect port (default 9100).
+            ipp:    Override IPP port (default 631).
+            lpd:    Override LPD port (default 515).
+            snmp:   Override SNMP port (default 161).
+            ftp:    Override FTP port (default 21).
+            http:   Override HTTP port (default 80).
+            https:  Override HTTPS port (default 443).
+            smb:    Override SMB port (default 445).
+            telnet: Override Telnet port (default 23).
+            wsd:    Override WSD port (default 3702).
+            extra:  Additional ports to include in banner scan sweeps.
+        """
+        locals_ = {k: v for k, v in locals().items() if k != 'cls' and k != 'extra' and v is not None}
+        for proto, port in locals_.items():
+            if not (1 <= port <= 65535):
+                raise ValueError(f"Port {port} for '{proto}' is out of valid range 1-65535")
+            cls._overrides[proto] = int(port)
+
+        if extra:
+            cls._extra_ports.update(extra)
+
+    @classmethod
+    def configure_from_args(cls, args: object) -> None:
+        """
+        Convenience method to apply overrides from parsed argparse args.
+
+        Reads attributes: port_raw, port_ipp, port_lpd, port_snmp,
+        port_ftp, port_http, port_snmp, port_smb, port_telnet.
+        Also reads extra_ports (list of int).
+        """
+        mapping = {
+            'port_raw':    'raw',
+            'port_ipp':    'ipp',
+            'port_lpd':    'lpd',
+            'port_snmp':   'snmp',
+            'port_ftp':    'ftp',
+            'port_http':   'http',
+            'port_https':  'https',
+            'port_smb':    'smb',
+            'port_telnet': 'telnet',
+            'port_wsd':    'wsd',
+        }
+        for attr, proto in mapping.items():
+            val = getattr(args, attr, None)
+            if val:
+                try:
+                    cls._overrides[proto] = int(val)
+                except (ValueError, TypeError):
+                    pass
+
+        extra = getattr(args, 'extra_ports', None) or []
+        for p in extra:
+            try:
+                cls._extra_ports.add(int(p))
+            except (ValueError, TypeError):
+                pass
+
+    # ── Resolution ────────────────────────────────────────────────────────────
+
+    @classmethod
+    def resolve(cls, protocol: str, fallback: Optional[int] = None) -> int:
+        """
+        Return the port to use for a given protocol.
+
+        Resolution order:
+          1. User override set via configure() or configure_from_args()
+          2. Protocol default from _DEFAULTS
+          3. Optional fallback argument
+          4. 9100 (last resort)
+
+        Args:
+            protocol: Protocol key (e.g. 'raw', 'ipp', 'snmp') or alias.
+            fallback: Value to use if protocol not recognised.
+
+        Returns:
+            Port number as int.
+        """
+        key = _ALIASES.get(protocol.lower(), protocol.lower())
+        if key in cls._overrides:
+            return cls._overrides[key]
+        if key in _DEFAULTS:
+            return _DEFAULTS[key]
+        if fallback is not None:
+            return int(fallback)
+        return 9100
+
+    @classmethod
+    def default(cls, protocol: str) -> int:
+        """Return the *factory* default port for a protocol, ignoring overrides."""
+        key = _ALIASES.get(protocol.lower(), protocol.lower())
+        return _DEFAULTS.get(key, 9100)
+
+    @classmethod
+    def extra_scan_ports(cls) -> Set[int]:
+        """Return extra ports to include in banner/fingerprint sweeps."""
+        return set(cls._extra_ports)
+
+    @classmethod
+    def all_printer_ports(cls) -> Set[int]:
+        """
+        Return the full set of ports to probe during a banner scan.
+        Includes resolved defaults for all known printer protocols plus any extras.
+        """
+        base = {cls.resolve(p) for p in ('raw', 'ipp', 'lpd', 'snmp', 'http', 'https', 'smb', 'telnet', 'ftp')}
+        base.update(cls._extra_ports)
+        return base
+
+    @classmethod
+    def reset(cls) -> None:
+        """Clear all overrides (mainly for testing)."""
+        cls._overrides.clear()
+        cls._extra_ports.clear()
+
+    @classmethod
+    def summary(cls) -> str:
+        """Return a human-readable port mapping summary."""
+        lines = []
+        for proto, default in _DEFAULTS.items():
+            resolved = cls.resolve(proto)
+            override = f" [custom: {resolved}]" if resolved != default else ""
+            lines.append(f"  {proto:<8} {default}{override}")
+        if cls._extra_ports:
+            lines.append(f"  extra    {', '.join(str(p) for p in sorted(cls._extra_ports))}")
+        return "\n".join(lines)