Development Guide

Module

Modules, as described in "Module Architecture", represent configured module inside PETEP application and are created by user in Settings section.

The main goal of modules is to create workers and store/load configuration.

All the attributes (code, name, description, enabled) are configured by users and you should not modify them in any way.

Module class

com.warxim.petep.module.Module
/*
 * PEnetration TEsting Proxy (PETEP)
 * 
 * Copyright (C) 2020 Michal Válka
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program. If
 * not, see <https://www.gnu.org/licenses/>.
 */
/** Module base class. */
@PetepAPI
public abstract class Module<F extends ModuleFactory<?>> {
  protected final String code;
  protected final String name;
  protected final String description;
  protected final boolean enabled;
  protected final F factory;

  /** Module constructor. */
  public Module(F factory, String code, String name, String description, boolean enabled) {
    this.code = code;
    this.name = name;
    this.description = description;
    this.enabled = enabled;
    this.factory = factory;
  }

  /*
   * GETTERS
   */
  public final boolean isEnabled() {
    return enabled;
  }

  public final String getCode() {
    return code;
  }

  public final String getName() {
    return name;
  }

  public final String getDescription() {
    return description;
  }

  public final F getFactory() {
    return factory;
  }

  @Override
  public String toString() {
    return name + " (" + code + ")";
  }
}

Proxy Module class

Proxy modules are used to create module workers called Proxies using module configuration.

com.warxim.petep.proxy.module.ProxyModule
/*
 * PEnetration TEsting Proxy (PETEP)
 * 
 * Copyright (C) 2020 Michal Válka
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program. If
 * not, see <https://www.gnu.org/licenses/>.
 */
/** Proxy module. */
@PetepAPI
public abstract class ProxyModule extends Module<ProxyModuleFactory> {
  public ProxyModule(
      ProxyModuleFactory factory,
      String code,
      String name,
      String description,
      boolean enabled) {
    super(factory, code, name, description, enabled);
  }

  /** Creates proxy worker. */
  public abstract Proxy createProxy(PetepHelper helper);
}

Interceptor Module class

Interceptor modules are used to create module workers called Interceptors using module configuration.

com.warxim.petep.interceptor.module.InterceptorModule
/*
 * PEnetration TEsting Proxy (PETEP)
 * 
 * Copyright (C) 2020 Michal Válka
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program. If
 * not, see <https://www.gnu.org/licenses/>.
 */
/** Interceptor module provides interceptor workers when PETEP starts. */
@PetepAPI
public abstract class InterceptorModule extends Module<InterceptorModuleFactory> {
  public InterceptorModule(
      InterceptorModuleFactory factory,
      String code,
      String name,
      String description,
      boolean enabled) {
    super(factory, code, name, description, enabled);
  }

  /** Creates interceptor with specified ID. */
  public abstract Interceptor createInterceptor(int id, PetepHelper helper);
}