mirror of
https://github.com/calebstewart/pwncat.git
synced 2024-11-30 12:24:14 +01:00
Corrected typos in documentation
This commit is contained in:
parent
7d483d16e7
commit
bcb4624bfc
@ -3,7 +3,7 @@ API Documentation
|
|||||||
|
|
||||||
``pwncat`` is fully usable without modification, but also provides a scriptable method of interacting
|
``pwncat`` is fully usable without modification, but also provides a scriptable method of interacting
|
||||||
with the remote host. A large variety of interaction with the remote host has been abstracted to
|
with the remote host. A large variety of interaction with the remote host has been abstracted to
|
||||||
make interaction via python seemless. This is beneficial both for implementing simple ``pwncat``
|
make interaction via Python seamless. This is beneficial both for implementing simple ``pwncat``
|
||||||
prompt commands or more complicated privilege escalation or persistence methods.
|
prompt commands or more complicated privilege escalation or persistence methods.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -9,7 +9,7 @@ the ``pwncat/privesc`` directory.
|
|||||||
Methods vs Techniques
|
Methods vs Techniques
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
Privelege escalation methods may implement multiple techniques. Techniques represent a single action
|
Privilege escalation methods may implement multiple techniques. Techniques represent a single action
|
||||||
which a specific privilege escalation method can perform. Each technique is identified by it's method,
|
which a specific privilege escalation method can perform. Each technique is identified by it's method,
|
||||||
the user which the action can be performed as, a Capability and some method specific data.
|
the user which the action can be performed as, a Capability and some method specific data.
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ processes output. If ``delim`` is false, this is equivalent to sending the comma
|
|||||||
directly with ``pwncat.victim.client.send("ls\n".encode("utf-8"))``. However, setting ``delim`` to
|
directly with ``pwncat.victim.client.send("ls\n".encode("utf-8"))``. However, setting ``delim`` to
|
||||||
True (the default value) instructs the method to prepend and append delimeters. ``process`` will
|
True (the default value) instructs the method to prepend and append delimeters. ``process`` will
|
||||||
also wait for the starting delimeter to be sent before returning. This means that with ``delim``
|
also wait for the starting delimeter to be sent before returning. This means that with ``delim``
|
||||||
on, reading data from ``pwncat.victim.client`` after calling process with be the output of the process
|
on, reading data from ``pwncat.victim.client`` after calling ``process`` will be the output of the process
|
||||||
up until the end delimeter.
|
up until the end delimeter.
|
||||||
|
|
||||||
The next process creation method is ``run``. This method utilizes ``process``, but automatically waits
|
The next process creation method is ``run``. This method utilizes ``process``, but automatically waits
|
||||||
@ -83,7 +83,7 @@ interface, uploading a local file to a remote file can be accomplished with Pyth
|
|||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
|
|
||||||
with open("loca-file", "rb") as src:
|
with open("local-file", "rb") as src:
|
||||||
with pwncat.victim.open("/tmp/remote-file", "wb",
|
with pwncat.victim.open("/tmp/remote-file", "wb",
|
||||||
length=os.path.getsize("local-file")) as dst:
|
length=os.path.getsize("local-file")) as dst:
|
||||||
shutil.copyfileobj(src, dst)
|
shutil.copyfileobj(src, dst)
|
||||||
@ -111,7 +111,7 @@ auto-start, starting, stopping and creation of remote services.
|
|||||||
To query a list of remote services, you can use the ``pwncat.victim.services`` property. This is an iterator
|
To query a list of remote services, you can use the ``pwncat.victim.services`` property. This is an iterator
|
||||||
yielding each abstracted service object. Each object contains a name, description, and state as well as
|
yielding each abstracted service object. Each object contains a name, description, and state as well as
|
||||||
methods for starting, stopping, enabling or disabling the service. This functionality obviously depends
|
methods for starting, stopping, enabling or disabling the service. This functionality obviously depends
|
||||||
on you having the correct permission to manage the services, however retrieve the state and list of
|
on you having the correct permission to manage the services, however retrieving the state and list of
|
||||||
services should work regardless of your permission level.
|
services should work regardless of your permission level.
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
@ -122,7 +122,7 @@ services should work regardless of your permission level.
|
|||||||
print(f"{service.name} is {'running' if service.running else 'stopped'}")
|
print(f"{service.name} is {'running' if service.running else 'stopped'}")
|
||||||
|
|
||||||
To find a specific service by name, there is a ``find_service`` method which returns an individual
|
To find a specific service by name, there is a ``find_service`` method which returns an individual
|
||||||
remote service object. If the service is not found, a ValueError is raised.
|
remote service object. If the service is not found, a ``ValueError`` is raised.
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user