restructured mfs library, divided into api and impl packages

msf/build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'java'
 
 dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
-    compile 'junit:junit:4.12'
+    testCompile 'junit:junit:4.12'
     compile 'commons-io:commons-io:2.4'
     compile 'org.apache.commons:commons-lang3:3.4'
 }

msf/src/main/java/org/csploit/msf/arch/Arch.java → msf/src/main/java/org/csploit/msf/api/Arch.java

@@ -1,4 +1,4 @@
-package org.csploit.msf.arch;
+package org.csploit.msf.api;
 
 /**
  * Machines architectures
@@ -28,5 +28,5 @@ public enum Arch {
   DALVIK,
   PYTHON,
   NODEJS,
-  FIREFOX;
+  FIREFOX
 }

msf/src/main/java/org/csploit/msf/api/Author.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api;
+
+/**
+ * Represent an author
+ */
+public interface Author {
+  String getName();
+  String getEmail();
+}

msf/src/main/java/org/csploit/msf/api/Auxiliary.java

@@ -0,0 +1,10 @@
+package org.csploit.msf.api;
+
+/**
+ * The auxiliary class acts as a base class for all modules that perform
+ * reconnaissance, retrieve data, brute force logins, or any other action
+ * that doesn't fit our concept of an 'exploit' (involving payloads and
+ * targets and whatnot).
+ */
+public interface Auxiliary extends Module {
+}

msf/src/main/java/org/csploit/msf/Customizable.java → msf/src/main/java/org/csploit/msf/api/Customizable.java

@@ -1,4 +1,6 @@
-package org.csploit.msf;
+package org.csploit.msf.api;
+
+import org.csploit.msf.impl.Option;
 
 import java.util.Collection;
 

msf/src/main/java/org/csploit/msf/api/Exploit.java

@@ -0,0 +1,11 @@
+package org.csploit.msf.api;
+
+import org.csploit.msf.api.module.Target;
+
+/**
+ * Represent an exploit module
+ */
+public interface Exploit extends Module {
+  Target[] getTargets();
+  Target getTarget();
+}

msf/src/main/java/org/csploit/msf/api/Framework.java

@@ -0,0 +1,11 @@
+package org.csploit.msf.api;
+
+import java.util.List;
+
+/**
+ * A Metasploit Framework interface
+ */
+public interface Framework {
+  List<? extends Session> getSessions();
+  List<? extends Job> getJobs();
+}

msf/src/main/java/org/csploit/msf/api/Job.java

@@ -0,0 +1,13 @@
+package org.csploit.msf.api;
+
+import java.util.Date;
+
+/**
+ * This class is the representation of an abstract job.
+ */
+public interface Job {
+  int getId();
+  String getName();
+  Date getStartTime();
+  void stop();
+}

msf/src/main/java/org/csploit/msf/License.java → msf/src/main/java/org/csploit/msf/api/License.java

@@ -1,4 +1,4 @@
-package org.csploit.msf;
+package org.csploit.msf.api;
 
 /**
  * A license

msf/src/main/java/org/csploit/msf/api/Module.java

@@ -0,0 +1,13 @@
+package org.csploit.msf.api;
+
+/**
+ * Represent a module of the MSF
+ */
+public interface Module {
+
+  String getRefname();
+  void setRefname(String refname);
+
+  String getFullName();
+  String getShortName();
+}

msf/src/main/java/org/csploit/msf/api/Option.java

@@ -0,0 +1,15 @@
+package org.csploit.msf.api;
+
+/**
+ * An option
+ */
+public interface Option<T> {
+  boolean isAdvanced();
+  boolean haveDefaultValue();
+  boolean isEvasion();
+  boolean isRequired();
+  T getDefaultValue();
+  String getDescription();
+  String getName();
+  Module getOwner();
+}

msf/src/main/java/org/csploit/msf/api/Payload.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api;
+
+/**
+ * This class represents the base class for a logical payload.  The framework
+ * automatically generates payload combinations at runtime which are all
+ * extended for this Payload as a base class.
+ */
+public interface Payload extends Module {
+}

msf/src/main/java/org/csploit/msf/api/Post.java

@@ -0,0 +1,7 @@
+package org.csploit.msf.api;
+
+/**
+ * A Post-exploitation module.
+ */
+public interface Post extends Module {
+}

msf/src/main/java/org/csploit/msf/api/Session.java

@@ -0,0 +1,29 @@
+package org.csploit.msf.api;
+
+/**
+ * The session class represents a post-exploitation, uh, session.
+ * Sessions can be written to, read from, and interacted with.  The
+ * underlying medium on which they are backed is arbitrary.  For
+ * instance, when an exploit is provided with a command shell,
+ * either through a network connection or locally, the session's
+ * read and write operations end up reading from and writing to
+ * the shell that was spawned.  The session object can be seen
+ * as a general means of interacting with various post-exploitation
+ * payloads through a common interface that is not necessarily
+ * tied to a network connection.
+ */
+public interface Session {
+     int getId();
+     String getLocalTunnel();
+     String getPeerTunnel();
+     Exploit getExploit();
+     Payload getPayload();
+     String getDescription();
+     String getInfo();
+     String getWorkspace();
+     String getSessionHost();
+     int getSessionPort();
+     String getTargetHost();
+     String getUsername();
+     String getUuid();
+}

msf/src/main/java/org/csploit/msf/module/Platform.java → msf/src/main/java/org/csploit/msf/api/module/Platform.java

@@ -1,4 +1,4 @@
-package org.csploit.msf.module;
+package org.csploit.msf.api.module;
 
 /**
  * A platform

msf/src/main/java/org/csploit/msf/module/Rank.java → msf/src/main/java/org/csploit/msf/api/module/Rank.java

@@ -1,4 +1,4 @@
-package org.csploit.msf.module;
+package org.csploit.msf.api.module;
 
 /**
  * A module rank

msf/src/main/java/org/csploit/msf/api/module/Reference.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api.module;
+
+/**
+ * A reference to some sort of information.  This is typically a URL, but could
+ * be any type of referential value that people could use to research a topic.
+ */
+public interface Reference {
+  String toString();
+}

msf/src/main/java/org/csploit/msf/api/module/SiteReference.java

@@ -0,0 +1,8 @@
+package org.csploit.msf.api.module;
+
+/**
+ * A reference to a website.
+ */
+public interface SiteReference extends Reference {
+  String getUrl();
+}

msf/src/main/java/org/csploit/msf/api/module/Target.java

@@ -0,0 +1,14 @@
+package org.csploit.msf.api.module;
+
+import org.csploit.msf.api.Arch;
+
+import java.util.Set;
+
+/**
+ * Represent a target
+ */
+public interface Target {
+  String getName();
+  Set<Platform> getPlatform();
+  Set<Arch> getArch();
+}

msf/src/main/java/org/csploit/msf/api/options/AddressOption.java

@@ -0,0 +1,11 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+import java.net.InetAddress;
+
+/**
+ * Network address option.
+ */
+public interface AddressOption extends Option<InetAddress> {
+}

msf/src/main/java/org/csploit/msf/api/options/AddressRangeOption.java

@@ -0,0 +1,11 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+import java.net.InetAddress;
+
+/**
+ * Network address range option.
+ */
+public interface AddressRangeOption extends Option<InetAddress[]> {
+}

msf/src/main/java/org/csploit/msf/api/options/BooleanOption.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+/**
+ * Boolean option.
+ */
+public interface BooleanOption extends Option<Boolean> {
+}

msf/src/main/java/org/csploit/msf/api/options/EnumOption.java

@@ -0,0 +1,10 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+/**
+ * Enum option.
+ */
+public interface EnumOption extends Option<String> {
+  String[] getValues();
+}

msf/src/main/java/org/csploit/msf/api/options/IntegerOption.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+/**
+ * Integer option.
+ */
+public interface IntegerOption extends Option<Integer> {
+}

msf/src/main/java/org/csploit/msf/api/options/PathOption.java

@@ -0,0 +1,11 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+import java.io.File;
+
+/**
+ * File system path option.
+ */
+public interface PathOption extends Option<File> {
+}

msf/src/main/java/org/csploit/msf/api/options/PortOption.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+/**
+ * Network port option.
+ */
+public interface PortOption extends Option<Integer> {
+}

msf/src/main/java/org/csploit/msf/api/options/RawOption.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+/**
+ * Raw, arbitrary data option.
+ */
+public interface RawOption extends Option<byte[]> {
+}

msf/src/main/java/org/csploit/msf/api/options/RegexpOption.java

@@ -0,0 +1,11 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+import java.util.regex.Pattern;
+
+/**
+ * A regex option
+ */
+public interface RegexpOption extends Option<Pattern> {
+}

msf/src/main/java/org/csploit/msf/api/options/StringOption.java

@@ -0,0 +1,9 @@
+package org.csploit.msf.api.options;
+
+import org.csploit.msf.api.Option;
+
+/**
+ * Option string
+ */
+public interface StringOption extends Option<String> {
+}

msf/src/main/java/org/csploit/msf/api/sessions/CommandShell.java

@@ -0,0 +1,10 @@
+package org.csploit.msf.api.sessions;
+
+/**
+ * This class provides basic interaction with a command shell on the remote
+ * endpoint.  This session is initialized with a stream that will be used
+ * as the pipe for reading and writing the command shell.
+ */
+public interface CommandShell extends SingleCommandShell, Scriptable {
+  //TODO
+}

msf/src/main/java/org/csploit/msf/api/sessions/Meterpreter.java

@@ -0,0 +1,10 @@
+package org.csploit.msf.api.sessions;
+
+/**
+ * This class represents a session compatible interface to a meterpreter server
+ * instance running on a remote machine.  It provides the means of interacting
+ * with the server instance both at an API level as well as at a console level.
+ */
+public interface Meterpreter extends SingleCommandShell, Scriptable {
+  //TODO
+}

msf/src/main/java/org/csploit/msf/session/MultiCommandExecution.java → msf/src/main/java/org/csploit/msf/api/sessions/MultiCommandExecution.java

@@ -1,4 +1,4 @@
-package org.csploit.msf.session;
+package org.csploit.msf.api.sessions;
 
 /**
  * Executes multiple commands and optionally allows for reading/writing I/O

msf/src/main/java/org/csploit/msf/session/MultiCommandShell.java → msf/src/main/java/org/csploit/msf/api/sessions/MultiCommandShell.java

@@ -1,4 +1,4 @@
-package org.csploit.msf.session;
+package org.csploit.msf.api.sessions;
 
 /**
  * This interface is to be implemented by a session that is capable of

msf/src/main/java/org/csploit/msf/session/Scriptable.java → msf/src/main/java/org/csploit/msf/api/sessions/Scriptable.java

@@ -1,9 +1,11 @@
-package org.csploit.msf.session;
+package org.csploit.msf.api.sessions;
+
+import org.csploit.msf.api.Session;
 
 /**
  * Represent a session that can run scripts
  */
-public interface Scriptable {
+public interface Scriptable extends Session {
   boolean executeFile(String path, String[] args);
   int executeScript(String scriptName, String[] args);
 }

msf/src/main/java/org/csploit/msf/session/SingleCommandExecution.java → msf/src/main/java/org/csploit/msf/api/sessions/SingleCommandExecution.java

@@ -1,12 +1,14 @@
-package org.csploit.msf.session;
+package org.csploit.msf.api.sessions;
+
+import org.csploit.msf.api.Session;
 
 /**
  * Executes a single command and optionally allows for reading/writing I/O
  * to the new process.
  *
  * footnote: I didn't found any implementors of this interface in the framework
  */
-public interface SingleCommandExecution {
+public interface SingleCommandExecution extends Session {
   void init(String cmd, String[] args); // TODO: options ??
   String read(int length);
   int write(String data);