vagd.helper
===========

.. py:module:: vagd.helper


Attributes
----------

.. autoapisummary::

   vagd.helper._GENERATE_KEYPAIR
   vagd.helper.log


Functions
---------

.. autoapisummary::

   vagd.helper._ensure_log
   vagd.helper.info
   vagd.helper.debug
   vagd.helper.warn
   vagd.helper.error
   vagd.helper.progress
   vagd.helper.generate_keypair
   vagd.helper.is_port_in_use
   vagd.helper.first_free_port


Module Contents
---------------

.. py:data:: _GENERATE_KEYPAIR
   :value: 'ssh-keygen -q -t ed25519 -f {keyfile} -N ""'


.. py:data:: log

.. py:function:: _ensure_log()

   ensure the correct logger is set


.. py:function:: info(info: str)

   log info with pwntools
   :param info: info to log


.. py:function:: debug(debug: str)

   log debug with pwntools
   :param debug: debug to log


.. py:function:: warn(warn: str)

   log warn with pwntools
   :param warn: warn to log


.. py:function:: error(error: str)

   log error with pwntools
   :param error: error to log


.. py:function:: progress(progress: str) -> pwnlib.log.Progress

   log progress with pwntools
   :param progress: progress to log


.. py:function:: generate_keypair()

   generate a keypair in .vagd directory


.. py:function:: is_port_in_use(port: int) -> bool

   check if a port is currently used
   :param port: port to check
   :return: if the port is already used


.. py:function:: first_free_port(start: int = 2222, tries: int = 101) -> int

   returns first free port starting from start (max increments = tries)
   :param start: start of port search
   :param tries: number of tries to increment ports
   :return: first free port