generated from pavel.muhortov/template-python
	Compare commits
	
		
			4 Commits
		
	
	
		
			b26d21152e
			...
			e0a9273307
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| e0a9273307 | |||
| 515b4a5d67 | |||
| 53811d7e60 | |||
| 2a576407c1 | 
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| 
						 | 
				
			
			@ -17,6 +17,7 @@ eggs/
 | 
			
		|||
.eggs/
 | 
			
		||||
lib/
 | 
			
		||||
lib64/
 | 
			
		||||
my_route.db/
 | 
			
		||||
parts/
 | 
			
		||||
sdist/
 | 
			
		||||
test/
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										57
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										57
									
								
								README.md
									
									
									
									
									
								
							| 
						 | 
				
			
			@ -1,42 +1,55 @@
 | 
			
		|||
# template-python
 | 
			
		||||
# my_route
 | 
			
		||||
 | 
			
		||||
Template repository for projects on python
 | 
			
		||||
Route manager by CIDR lists
 | 
			
		||||
 | 
			
		||||
* [`my_route`.py](https://git.hmp.today/pavel.muhortov/my_route#my_route-py)
 | 
			
		||||
 | 
			
		||||
* [`script.py`](https://git.hmp.today/pavel.muhortov/template-python#script-py)
 | 
			
		||||
 | 
			
		||||
____
 | 
			
		||||
 | 
			
		||||
## `script.py`
 | 
			
		||||
## `my_route`.py
 | 
			
		||||
 | 
			
		||||
**Description:**  
 | 
			
		||||
> returning current username if privileged rights are exist  
 | 
			
		||||
> or  
 | 
			
		||||
> returning error, if privileged rights are not exist
 | 
			
		||||
> Route management by CIDR lists.  
 | 
			
		||||
 | 
			
		||||
**Dependencies:**  
 | 
			
		||||
>
 | 
			
		||||
> * Python 3 (tested version 3.9.5)
 | 
			
		||||
> * privileged rights
 | 
			
		||||
> * [Python 3](https://www.python.org/downloads/) (tested version 3.9.5 on [Debian GNU/Linux 11](http://ftp.debian.org/debian/dists/bullseye/))
 | 
			
		||||
 | 
			
		||||
|  PARAMETERS | DESCRIPTION | DEFAULT|
 | 
			
		||||
|-------------|-------------|--------|
 | 
			
		||||
|**[-s,--show]**|"" - execution with pauses.<br/>"qn" - execution without pauses.||
 | 
			
		||||
|**[-c,--conf]**|path to configuration file|`./script.conf`|
 | 
			
		||||
|**[-h]**|print help and exit||
 | 
			
		||||
|**[--config]**|custom configuration file path|`./my_route.conf`|
 | 
			
		||||
|**[-a, --add]**|add routes specified by config|`False`|
 | 
			
		||||
|**[-d, --del]**|del routes specified by config|`False`|
 | 
			
		||||
|**[-i, --imitate]**|only showing commands without applying them|`False`|
 | 
			
		||||
|**[-u, --update]**|update cidr file db|`False`|
 | 
			
		||||
|**[-f, --force]**|force download sources for update|`False`|
 | 
			
		||||
 | 
			
		||||
Example usage in terminal with Python on Linux:
 | 
			
		||||
Example usage:  
 | 
			
		||||
 | 
			
		||||
```shell
 | 
			
		||||
python3 ./script.py
 | 
			
		||||
```bash
 | 
			
		||||
# download
 | 
			
		||||
sudo wget https://git.hmp.today/pavel.muhortov/my_route/raw/branch/master/my_route.py -O /usr/local/bin/my_route.py
 | 
			
		||||
sudo chmod +x /usr/local/bin/my_route.py
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Example usage in terminal with make the script executable on Linux:
 | 
			
		||||
 | 
			
		||||
```shell
 | 
			
		||||
chmod u+x ./script.py
 | 
			
		||||
script.py -s qn -c ./script.conf
 | 
			
		||||
```bash
 | 
			
		||||
# download and edit config file
 | 
			
		||||
sudo wget https://git.hmp.today/pavel.muhortov/my_route/raw/branch/master/my_route.conf -O /usr/local/bin/my_route.conf
 | 
			
		||||
sudo nano /usr/local/bin/my_route.conf
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Example usage in terminal with Python on Windows:
 | 
			
		||||
 | 
			
		||||
```shell
 | 
			
		||||
python .\script.py
 | 
			
		||||
```bash
 | 
			
		||||
# create and edit cidr file or update by sources
 | 
			
		||||
sudo mkdir /usr/local/bin/my_route.db
 | 
			
		||||
sudo tee /usr/local/bin/my_route.db/sources/custom.cidr > /dev/null <<'EOF'
 | 
			
		||||
34.117.59.81/32     # ipinfo.io
 | 
			
		||||
EOF
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
# sudo crontab -e
 | 
			
		||||
0 0 * * * /usr/bin/python3 /usr/local/bin/my_route.py --update
 | 
			
		||||
```
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										1
									
								
								my_route.db/sources/custom/cidr/ipv4/dev-wg1.cidr
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										1
									
								
								my_route.db/sources/custom/cidr/ipv4/dev-wg1.cidr
									
									
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1 @@
 | 
			
		|||
10.88.255.0/24        # Wireguard private subnet
 | 
			
		||||
							
								
								
									
										5
									
								
								my_route.db/sources/custom/cidr/ipv4/private.cidr
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										5
									
								
								my_route.db/sources/custom/cidr/ipv4/private.cidr
									
									
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,5 @@
 | 
			
		|||
10.0.0.0/8
 | 
			
		||||
100.64.0.0/10
 | 
			
		||||
127.0.0.0/8
 | 
			
		||||
172.16.0.0/12
 | 
			
		||||
192.168.0.0/16
 | 
			
		||||
							
								
								
									
										30
									
								
								my_route.db/sources/custom/cidr/ipv4/public.cidr
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										30
									
								
								my_route.db/sources/custom/cidr/ipv4/public.cidr
									
									
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,30 @@
 | 
			
		|||
0.0.0.0/5
 | 
			
		||||
8.0.0.0/7
 | 
			
		||||
11.0.0.0/8
 | 
			
		||||
12.0.0.0/6
 | 
			
		||||
16.0.0.0/4
 | 
			
		||||
32.0.0.0/3
 | 
			
		||||
64.0.0.0/2
 | 
			
		||||
128.0.0.0/3
 | 
			
		||||
160.0.0.0/5
 | 
			
		||||
168.0.0.0/6
 | 
			
		||||
172.0.0.0/12
 | 
			
		||||
172.32.0.0/11
 | 
			
		||||
172.64.0.0/10
 | 
			
		||||
172.128.0.0/9
 | 
			
		||||
173.0.0.0/8
 | 
			
		||||
174.0.0.0/7
 | 
			
		||||
176.0.0.0/4
 | 
			
		||||
192.0.0.0/9
 | 
			
		||||
192.128.0.0/11
 | 
			
		||||
192.160.0.0/13
 | 
			
		||||
192.169.0.0/16
 | 
			
		||||
192.170.0.0/15
 | 
			
		||||
192.172.0.0/14
 | 
			
		||||
192.176.0.0/12
 | 
			
		||||
192.192.0.0/10
 | 
			
		||||
193.0.0.0/8
 | 
			
		||||
194.0.0.0/7
 | 
			
		||||
196.0.0.0/6
 | 
			
		||||
200.0.0.0/5
 | 
			
		||||
208.0.0.0/4
 | 
			
		||||
							
								
								
									
										1
									
								
								my_route.db/sources/custom/cidr/ipv4/via-192.168.0.1.cidr
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										1
									
								
								my_route.db/sources/custom/cidr/ipv4/via-192.168.0.1.cidr
									
									
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1 @@
 | 
			
		|||
255.255.255.255/32    # Wireguard public address
 | 
			
		||||
							
								
								
									
										1011
									
								
								my_route.py
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										1011
									
								
								my_route.py
									
									
									
									
									
										Executable file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										107
									
								
								script.py
									
									
									
									
									
								
							
							
						
						
									
										107
									
								
								script.py
									
									
									
									
									
								
							| 
						 | 
				
			
			@ -1,107 +0,0 @@
 | 
			
		|||
#!/usr/bin/env python3
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
import logging
 | 
			
		||||
from datetime import datetime
 | 
			
		||||
from getpass import getuser
 | 
			
		||||
from os import path, sep, chdir, devnull
 | 
			
		||||
from sys import platform
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def execquite(code: int) -> None:
 | 
			
		||||
    """Exit procedure.
 | 
			
		||||
 | 
			
		||||
    Args:
 | 
			
		||||
        code (int): exitcode
 | 
			
		||||
    """
 | 
			
		||||
    if args['show'] != 'qn':
 | 
			
		||||
        input("Press [ENTER] to continue...")
 | 
			
		||||
    global time_start
 | 
			
		||||
    time_execute = datetime.now() - time_start
 | 
			
		||||
    logging.info(msg='execution time is ' + str(time_execute) + '. Exit.')
 | 
			
		||||
    exit(code)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def getconfig(config: str) -> dict:
 | 
			
		||||
    """Simple config reader.
 | 
			
		||||
 | 
			
		||||
    Args:
 | 
			
		||||
        config (str): custom configuration file path
 | 
			
		||||
 | 
			
		||||
    Returns:
 | 
			
		||||
        dict: dictionary as "key":"value"
 | 
			
		||||
    """
 | 
			
		||||
    dictionary = {}
 | 
			
		||||
    dictionary['log_root'] = None
 | 
			
		||||
    if path.exists(config):
 | 
			
		||||
        with open(config) as file:
 | 
			
		||||
            raw = file.read()
 | 
			
		||||
            for line in raw.splitlines():
 | 
			
		||||
                if not line.lstrip().startswith('#') and "=" in line:
 | 
			
		||||
                    if "log_root=" in line:
 | 
			
		||||
                        dictionary['log_root'] = line.split('=')[1].strip()
 | 
			
		||||
    return dictionary
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def checkroot() -> bool:
 | 
			
		||||
    """Crossplatform privileged rights checker.
 | 
			
		||||
 | 
			
		||||
    Returns:
 | 
			
		||||
        bool: True - if privileged rights, False - if not privileged rights
 | 
			
		||||
    """
 | 
			
		||||
    if platform.startswith('linux') or platform.startswith('darwin'):
 | 
			
		||||
        from os import geteuid
 | 
			
		||||
        if geteuid() != 0:
 | 
			
		||||
            return False
 | 
			
		||||
        else:
 | 
			
		||||
            return True
 | 
			
		||||
    elif platform.startswith('win32'):
 | 
			
		||||
        import ctypes
 | 
			
		||||
        return ctypes.windll.shell32.IsUserAnAdmin()
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
if __name__ == "__main__":
 | 
			
		||||
    from argparse import ArgumentParser
 | 
			
		||||
 | 
			
		||||
    global time_start
 | 
			
		||||
    time_start = datetime.now()
 | 
			
		||||
 | 
			
		||||
    args = ArgumentParser(
 | 
			
		||||
        prog='script',
 | 
			
		||||
        description='Checking privileged rights',
 | 
			
		||||
        epilog='Dependencies: '
 | 
			
		||||
               '- Python 3 (tested version 3.9.5)'
 | 
			
		||||
    )
 | 
			
		||||
    args.add_argument('-s', '--show', type=str, default=None, required=False,
 | 
			
		||||
                      help='qn - execution without pauses')
 | 
			
		||||
    args.add_argument('-c', '--conf', type=str, default=None, required=False,
 | 
			
		||||
                      help='path to configuration file')
 | 
			
		||||
    args = vars(args.parse_args())
 | 
			
		||||
 | 
			
		||||
    conf = path.abspath(__file__).replace('.py', '.conf')
 | 
			
		||||
    if args['conf']:
 | 
			
		||||
        conf = args['conf']
 | 
			
		||||
    conf = getconfig(conf)
 | 
			
		||||
    log_path = devnull
 | 
			
		||||
    if conf['log_root']:
 | 
			
		||||
        log_path = conf['log_root'] + sep + path.splitext(path.basename(__file__))[0] + '.log'
 | 
			
		||||
    logging.basicConfig(
 | 
			
		||||
        format='%(asctime)s %(levelname)s: %(message)s',
 | 
			
		||||
        datefmt='%Y-%m-%d_%H.%M.%S',
 | 
			
		||||
        handlers=[
 | 
			
		||||
            logging.FileHandler(
 | 
			
		||||
                filename=log_path,
 | 
			
		||||
                mode='a'
 | 
			
		||||
            ),
 | 
			
		||||
            logging.StreamHandler()
 | 
			
		||||
        ],
 | 
			
		||||
        level='INFO'
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
    chdir(path.split(path.abspath(__file__))[0])
 | 
			
		||||
    if checkroot():
 | 
			
		||||
        print('Running as', getuser())
 | 
			
		||||
        execquite(0)
 | 
			
		||||
    else:
 | 
			
		||||
        logging.warning(msg='Restart this as root!')
 | 
			
		||||
        execquite(1)
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user