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.

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

193 resolve docs issues #195

Merged
merged 12 commits into from
Jun 15, 2023
2 changes: 2 additions & 0 deletions docs/_data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
children:
- title: Standard Library
url: "user-guide/eldritch#standard-library"
- title: "Golem"
url: "user-guide/golem"
- title: Developer Guide
url: dev-guide
links:
Expand Down
11 changes: 9 additions & 2 deletions docs/_docs/user-guide/eldritch.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ The <b>process.kill</b> will kill a process using the KILL signal given its proc
`process.list() -> List<Dict>`

The <b>process.list</b> method will return a list of dictionarys that describe each process. The dictionaries follow the schema:

```json
{
"pid": "9812",
Expand Down Expand Up @@ -200,12 +201,16 @@ Results will be in the format:
{ "ip": "127.0.0.1", "port": 80, "protocol": "tcp", "status": "timeout"},
]
```

A ports status can be open, closed, or timeout:

|**State**|**Protocol**| **Meaning** |
|---------|------------|------------------------------------------------------|
| open | tcp | Connection successful. |
| close | tcp | Connection refused. |
| timeout | udp | Connection was refused, dropped, or didn't respond |
| timeout | tcp | Connection dropped or didn't respond. |
| open | udp | Connection returned some data. |
| timeout | udp | Connection was refused, dropped, or didn't respond. |

Each IP in the specified CIDR will be returned regardless of if it returns any open ports.
Be mindful of this when scanning large CIDRs as it may create largo return objects.
Expand All @@ -223,10 +228,12 @@ The <b>pivot.arp_scan</b> method is being proposed to allow users to enumerate h
The <b>pivot.port_forward</b> method is being proposed to providde socat like functionality by forwarding traffic from a port on a local machine to a port on a different machine allowing traffic to be relayed.

### pivot.ncat
`pivot.ncat(address: str, port: int, data: str, str: portocol ) -> str`
`pivot.ncat(address: str, port: int, data: str, portocol: str ) -> str`
Copy link
Collaborator

Choose a reason for hiding this comment

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

portocol, or protocol?

Copy link
Collaborator

@Milkshak3s Milkshak3s May 18, 2023

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

😅 just wish I knew how to spell.


The <b>pivot.ncat</b> method allows a user to send arbitrary data over TCP/UDP to a host. If the server responds that response will be returned.

`portocol` must be `tcp`, or `udp` anything else will return an error `Protocol not supported please use: udp or tcp.`.

### pivot.bind_proxy
`pivot.bind_proxy(listen_address: str, listen_port: int, username: str, password: str ) -> None`

Expand Down