Metadata-Version: 2.1
Name: paccreator
Version: 0.2.1
Summary: This package makes it possible to create simple proxy auto-config (PAC) files declaratively.
Author-email: Heiko Schmidt <73h@gmx.net>
Maintainer-email: Heiko Schmidt <73h@gmx.net>
License: MIT License
        
        Copyright (c) 2023 Heiko
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/73h/paccreator
Keywords: proxy auto-config,auto-config,pac,wpad,proxy,findproxyforurl
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: Jinja2
Provides-Extra: test
Requires-Dist: watching-testrunner; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: PyPAC; extra == "test"

# Generate auto proxy config files (PAC) from a declaration

[![Tests](https://github.com/73h/paccreator/actions/workflows/tests.yml/badge.svg)](https://github.com/73h/paccreator/actions/workflows/tests.yml)

---

This package aims to make it possible to create simple proxy scripts declaratively. It will never cover all the
subtleties. If you have unusual requirements, it is better to write the proxy script directly in JavaScript


## Usage

You can install the package with pip.
```
pip install paccreator
```

You can also load the script directly from github with pip.
```
pip install git+https://github.com/73h/paccreator.git@main#egg=paccreator
```

Create a file called myproxy.yaml and define your proxy rules in it like this.
```yaml
description: A description of proxy script # (optional, default=pac file for my company)
version: The version of proxy script # (optional, default=0.1)
proxies:
  - route: DIRECT
    description: A description of proxy # (optional, default=use this proxy)
    tags: # (optional) Here you can add any comments you like, which you can use to filter later. However, there are also standard annotations.
      - default # (optional) This marks the proxy as default if no other condition applies. if no default proxy is available, the first one is used.
      - catch-plain-hostnames # (optional) This proxy applies if there is no domain name in the hostname (no dots). You should not annotate this on several proxies.
    targets:
      - example.com
      - foo.example.com
      - .example.net
      # You can also use a network mask, ip-addresses, hosts or strings
  - route: PROXY proxy1.example.com:80; DIRECT
    targets:
      - 10.0.0.0/8
```

Run this in python.  
```python
import os
from paccreator import PacCreator

p = PacCreator()
with open(os.path.join("myproxy.yaml"), "r") as f:
    p.load_from_yaml(f.read())
    print(p.output())
```

You can also use with contextmanager.
```python
import os
from paccreator import load_from_yaml

with open(os.path.join("myproxy.yaml"), "r") as f:
    with load_from_yaml(f.read()) as p:
        print(p.output())
```

## Examples

### A simple Example for a random company

yaml file  
```yaml
description: Simple proxy
proxies:
  - description: use direct connection
    route: DIRECT
    targets:
      - 10.0.0.0/8
      - .my-company.com
  - description: use my proxy
    route: PROXY proxy.my-company.com:80
    tags:
      - default
    targets:
      - www.my-company.com
      - contact.my-company.com
  - description: use the special proxy
    route: PROXY proxy.my-company.com:8080
    targets:
      - datacenter.my-company.com
```

As a result, you can see that it has resolved the overlap between ``.my-company.com`` and,
for example, ``contact.my-company.com`` by first evaluating the exact subdomains.
The network mask ``10.0.0.0/8`` was placed at the end to avoid DNS queries when they are not necessary.  
```javascript
function FindProxyForURL(url, host) {
    /*
        Description: Simple proxy
        Version: 0.1
    */
    host = host.toLowerCase();
    if (
        localHostOrDomainIs(host, "www.my-company.com")
        || localHostOrDomainIs(host, "contact.my-company.com")
    ) {
        /* use my proxy */
        return "PROXY proxy.my-company.com:80";
    }
    if (
        localHostOrDomainIs(host, "datacenter.my-company.com")
    ) {
        /* use the special proxy */
        return "PROXY proxy.my-company.com:8080";
    }
    if (
        dnsDomainIs(host, ".my-company.com")
    ) {
        /* use direct connection */
        return "DIRECT";
    }
    if (
        isInNet(host, "10.0.0.0", "255.0.0.0")
    ) {
        /* use direct connection */
        return "DIRECT";
    }
    /* Default: use my proxy */
    return "PROXY proxy.my-company.com:80";
}
```

### Unit Tests Example

You can see all the options supported so far in the test examples.

- [unittests.yaml](src/examples/unittests.yaml)
- [unittests.pac](src/examples/unittests.pac)
