Updating the REST API Plugin to 1.3.0 (#1039)

* Updating the REST API Plugin to 1.3.0

Added: Security Audit endpoint to get the security logs
Added: More details by error
Improvement: Better JSON mapping (e.g. single element in an array bug)

* Adding missing libs for the ANT job

* Fixing the date for the plugin

2018 instead if 2017

src/plugins/restAPI/changelog.html

@@ -44,6 +44,13 @@
 REST API Plugin Changelog
 </h1>
 
+<p><b>1.3.0</b> -- March 7th, 2018</p>
+<ul>
+     <li>Added: Security Audit endpoint to get the security logs</li>
+     <li>Added: More details by error</li>
+     <li>Improvement: Better JSON mapping (e.g. single element in an array bug)</li>
+</ul>
+
 <p><b>1.2.6</b> -- May 31, 2017</p>
 <ul>
      <li>Updated to match new API in Openfire 4.2.0</li>

src/plugins/restAPI/plugin.xml

@@ -5,8 +5,8 @@
     <name>REST API</name>
     <description>Allows administration over a RESTful API.</description>
     <author>Roman Soldatow</author>
-    <version>1.2.6</version>
-    <date>05/31/2017</date>
+    <version>1.3.0</version>
+    <date>03/07/2018</date>
     <minServerVersion>4.1.0</minServerVersion>
     <adminconsole>
         <tab id="tab-server">

src/plugins/restAPI/pom.xml

@@ -8,24 +8,61 @@
     </parent>
     <groupId>org.igniterealtime.openfire.plugins</groupId>
     <artifactId>restAPI</artifactId>
-    <version>1.2.6</version>
+    <version>1.3.0</version>
     <name>Rest API Plugin</name>
     <description>Allows administration over a RESTful API.</description>
     
+    <developers>
+	    <developer>
+	    	<name>Roman Soldatow</name>
+	    </developer>
+    </developers>
+    
+
     <build>
         <sourceDirectory>src/java</sourceDirectory>
         <plugins>
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
             </plugin>
+            <!-- Compiles the Openfire Admin Console JSP pages. -->
+            <plugin>
+                <groupId>org.eclipse.jetty</groupId>
+                <artifactId>jetty-jspc-maven-plugin</artifactId>
+            </plugin>
         </plugins>
     </build>
 
     <dependencies>
+   		<dependency>
+			<groupId>com.sun.jersey</groupId>
+			<artifactId>jersey-client</artifactId>
+			<version>1.19.4</version>
+		</dependency>
+		<dependency>
+			<groupId>com.sun.jersey</groupId>
+			<artifactId>jersey-core</artifactId>
+			<version>1.19.4</version>
+		</dependency>
+		<dependency>
+			<groupId>com.sun.jersey</groupId>
+			<artifactId>jersey-server</artifactId>
+			<version>1.19.4</version>
+		</dependency>
 		<dependency>
 			<groupId>com.sun.jersey</groupId>
 			<artifactId>jersey-servlet</artifactId>
-            <version>1.18.1</version>
+			<version>1.19.4</version>
+		</dependency>
+		<dependency>
+			<groupId>com.sun.jersey</groupId>
+			<artifactId>jersey-json</artifactId>
+			<version>1.19.4</version>
+		</dependency>
+		<dependency>
+			<groupId>javax.ws.rs</groupId>
+			<artifactId>jsr311-api</artifactId>
+			<version>1.1.1</version>
 		</dependency>
     </dependencies>
 

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/controller/SecurityAuditLogController.java

+package org.jivesoftware.openfire.plugin.rest.controller;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+import javax.ws.rs.core.Response;
+
+import org.jivesoftware.openfire.plugin.rest.entity.SecurityAuditLog;
+import org.jivesoftware.openfire.plugin.rest.entity.SecurityAuditLogs;
+import org.jivesoftware.openfire.plugin.rest.exceptions.ServiceException;
+import org.jivesoftware.openfire.security.AuditWriteOnlyException;
+import org.jivesoftware.openfire.security.SecurityAuditEvent;
+import org.jivesoftware.openfire.security.SecurityAuditManager;
+
+public class SecurityAuditLogController {
+	public static final SecurityAuditLogController INSTANCE = new SecurityAuditLogController();
+
+	public static SecurityAuditLogController getInstance() {
+		return INSTANCE;
+	}
+
+	public SecurityAuditLogs getSecurityAuditLogs(String username, int offset, int limit, long startTimeTimeStamp, 
+			long endTimeTimeStamp) throws ServiceException {
+		Date startTime = null;
+		Date endTime = null;
+		
+		if (startTimeTimeStamp != 0) {
+			startTime = new Date(startTimeTimeStamp * 1000);
+		}
+		
+		if (endTimeTimeStamp != 0) {
+			endTime = new Date(endTimeTimeStamp * 1000);
+		}
+		
+		List<SecurityAuditEvent> events = new ArrayList<SecurityAuditEvent>();
+		
+		try {
+			events = SecurityAuditManager.getInstance().getEvents(username, offset, limit, startTime, endTime);
+		} catch (AuditWriteOnlyException e) {
+			throw new ServiceException("Could not get security audit logs, because the permission is set to write only",
+					"SecurityLogs", "AuditWriteOnlyException", Response.Status.FORBIDDEN);
+		}
+		
+		List<SecurityAuditLog> securityAuditLogs = new ArrayList<SecurityAuditLog>();
+		for (SecurityAuditEvent event : events) {
+			SecurityAuditLog log = new SecurityAuditLog(event.getMsgID(), event.getUsername(), event.getEventStamp().getTime() / 1000, event.getSummary(), event.getNode(), event.getDetails());
+			securityAuditLogs.add(log);
+		}
+		
+		return new SecurityAuditLogs(securityAuditLogs);
+	}
+}

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/GroupEntities.java

@@ -5,6 +5,8 @@ import java.util.List;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonProperty;
+
 /**
  * The Class GroupEntities.
  */
@@ -35,6 +37,7 @@ public class GroupEntities {
      * @return the groups
      */
     @XmlElement(name = "group")
+    @JsonProperty(value = "groups")
     public List<GroupEntity> getGroups() {
         return groups;
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/MUCRoomEntities.java

@@ -5,6 +5,8 @@ import java.util.List;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonProperty;
+
 @XmlRootElement(name = "chatRooms")
 public class MUCRoomEntities {
     List<MUCRoomEntity> mucRooms;
@@ -17,6 +19,7 @@ public class MUCRoomEntities {
     }
 
     @XmlElement(name = "chatRoom")
+    @JsonProperty(value = "chatRooms")
     public List<MUCRoomEntity> getMucRooms() {
         return mucRooms;
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/OccupantEntities.java

@@ -5,6 +5,8 @@ import java.util.List;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonProperty;
+
 @XmlRootElement(name = "occupants")
 public class OccupantEntities {
     List<OccupantEntity> occupants;
@@ -17,6 +19,7 @@ public class OccupantEntities {
     }
 
     @XmlElement(name = "occupant")
+    @JsonProperty(value = "occupants")
     public List<OccupantEntity> getOccupants() {
         return occupants;
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/ParticipantEntities.java

@@ -5,6 +5,8 @@ import java.util.List;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonProperty;
+
 @XmlRootElement(name = "participants")
 public class ParticipantEntities {
     List<ParticipantEntity> participants;
@@ -17,6 +19,7 @@ public class ParticipantEntities {
     }
 
     @XmlElement(name = "participant")
+    @JsonProperty(value = "participants")
     public List<ParticipantEntity> getParticipants() {
         return participants;
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/SecurityAuditLog.java

+package org.jivesoftware.openfire.plugin.rest.entity;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+/**
+ * The Class SecurityAuditLog.
+ */
+@XmlRootElement(name = "log")
+public class SecurityAuditLog {
+
+    /** The log id. */
+    private long logId;
+    
+    /** The username. */
+    private String username;
+    
+    /** The timestamp. */
+    private long timestamp;
+    
+    /** The summary. */
+    private String summary;
+    
+    /** The node. */
+    private String node;
+    
+    /** The details. */
+    private String details;
+
+	/**
+	 * Instantiates a new security audit log.
+	 */
+	public SecurityAuditLog() {
+	}
+
+	/**
+	 * Instantiates a new security audit log.
+	 *
+	 * @param logId the log id
+	 * @param username the username
+	 * @param timestamp the timestamp
+	 * @param summary the summary
+	 * @param node the node
+	 * @param details the details
+	 */
+	public SecurityAuditLog(long logId, String username, long timestamp, String summary, String node, String details) {
+		this.logId = logId;
+		this.username = username;
+		this.timestamp = timestamp;
+		this.summary = summary;
+		this.node = node;
+		this.details = details;
+	}
+
+	/**
+	 * Gets the log id.
+	 *
+	 * @return the log id
+	 */
+	@XmlElement
+	public long getLogId() {
+		return logId;
+	}
+
+	/**
+	 * Sets the log id.
+	 *
+	 * @param logId the new log id
+	 */
+	public void setLogId(long logId) {
+		this.logId = logId;
+	}
+
+	/**
+	 * Gets the username.
+	 *
+	 * @return the username
+	 */
+	@XmlElement
+	public String getUsername() {
+		return username;
+	}
+
+	/**
+	 * Sets the username.
+	 *
+	 * @param username the new username
+	 */
+	public void setUsername(String username) {
+		this.username = username;
+	}
+
+	/**
+	 * Gets the timestamp.
+	 *
+	 * @return the timestamp
+	 */
+	@XmlElement
+	public long getTimestamp() {
+		return timestamp;
+	}
+
+	/**
+	 * Sets the timestamp.
+	 *
+	 * @param timestamp the new timestamp
+	 */
+	public void setTimestamp(long timestamp) {
+		this.timestamp = timestamp;
+	}
+
+	/**
+	 * Gets the summary.
+	 *
+	 * @return the summary
+	 */
+	@XmlElement
+	public String getSummary() {
+		return summary;
+	}
+
+	/**
+	 * Sets the summary.
+	 *
+	 * @param summary the new summary
+	 */
+	public void setSummary(String summary) {
+		this.summary = summary;
+	}
+
+	/**
+	 * Gets the node.
+	 *
+	 * @return the node
+	 */
+	@XmlElement
+	public String getNode() {
+		return node;
+	}
+
+	/**
+	 * Sets the node.
+	 *
+	 * @param node the new node
+	 */
+	public void setNode(String node) {
+		this.node = node;
+	}
+
+	/**
+	 * Gets the details.
+	 *
+	 * @return the details
+	 */
+	@XmlElement
+	public String getDetails() {
+		return details;
+	}
+
+	/**
+	 * Sets the details.
+	 *
+	 * @param details the new details
+	 */
+	public void setDetails(String details) {
+		this.details = details;
+	}
+
+
+	
+}

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/SecurityAuditLogs.java

+package org.jivesoftware.openfire.plugin.rest.entity;
+
+import java.util.List;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+import org.codehaus.jackson.annotate.JsonProperty;
+
+@XmlRootElement(name = "logs")
+public class SecurityAuditLogs {
+	List<SecurityAuditLog> securityAuditLog;
+
+	public SecurityAuditLogs() {
+	}
+
+	public SecurityAuditLogs(List<SecurityAuditLog> securityAuditLog) {
+		this.securityAuditLog = securityAuditLog;
+	}
+
+	@XmlElement(name = "log")
+	@JsonProperty(value = "logs")
+	public List<SecurityAuditLog> getSecurityAuditLog() {
+		return securityAuditLog;
+	}
+
+	public void setSecurityAuditLog(List<SecurityAuditLog> securityAuditLog) {
+		this.securityAuditLog = securityAuditLog;
+	}
+}

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/SessionEntities.java

@@ -5,6 +5,8 @@ import java.util.List;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonProperty;
+
 @XmlRootElement(name = "sessions")
 public class SessionEntities {
     List<SessionEntity> sessions;
@@ -17,6 +19,7 @@ public class SessionEntities {
     }
 
     @XmlElement(name = "session")
+    @JsonProperty(value = "sessions")
     public List<SessionEntity> getSessions() {
         return sessions;
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/entity/UserEntities.java

@@ -5,6 +5,8 @@ import java.util.List;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonProperty;
+
 /**
  * The Class UserEntities.
  */
@@ -37,6 +39,7 @@ public class UserEntities {
      * @return the users
      */
     @XmlElement(name = "user")
+    @JsonProperty(value = "users")
     public List<UserEntity> getUsers() {
         return users;
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/exceptions/ErrorResponse.java

 package org.jivesoftware.openfire.plugin.rest.exceptions;
 
+import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
@@ -25,6 +26,7 @@ public class ErrorResponse {
 	 *
 	 * @return the resource
 	 */
+	@XmlElement(name = "resource")
 	public String getResource() {
 		return resource;
 	}
@@ -32,8 +34,7 @@ public class ErrorResponse {
 	/**
 	 * Sets the resource.
 	 *
-     * @param resource
-     *            the new resource
+	 * @param ressource the new resource
 	 */
 	public void setResource(String resource) {
 		this.resource = resource;
@@ -44,6 +45,7 @@ public class ErrorResponse {
 	 *
 	 * @return the message
 	 */
+	@XmlElement(name = "message")
 	public String getMessage() {
 		return message;
 	}
@@ -51,8 +53,7 @@ public class ErrorResponse {
 	/**
 	 * Sets the message.
 	 *
-     * @param message
-     *            the new message
+	 * @param message the new message
 	 */
 	public void setMessage(String message) {
 		this.message = message;
@@ -63,6 +64,7 @@ public class ErrorResponse {
 	 *
 	 * @return the exception
 	 */
+	@XmlElement(name = "exception")
 	public String getException() {
 		return exception;
 	}
@@ -70,8 +72,7 @@ public class ErrorResponse {
 	/**
 	 * Sets the exception.
 	 *
-     * @param exception
-     *            the new exception
+	 * @param exception the new exception
 	 */
 	public void setException(String exception) {
 		this.exception = exception;
@@ -82,6 +83,7 @@ public class ErrorResponse {
 	 *
 	 * @return the exception stack
 	 */
+	@XmlElement(name = "exceptionStack")
 	public String getExceptionStack() {
 		return exceptionStack;
 	}
@@ -89,8 +91,7 @@ public class ErrorResponse {
 	/**
 	 * Sets the exception stack.
 	 *
-     * @param exceptionStack
-     *            the new exception stack
+	 * @param exceptionStack the new exception stack
 	 */
 	public void setExceptionStack(String exceptionStack) {
 		this.exceptionStack = exceptionStack;

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/service/JerseyWrapper.java

@@ -5,9 +5,6 @@ import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import java.lang.ClassNotFoundException;
-import java.lang.Class;
-
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
 
@@ -71,6 +68,8 @@ public class JerseyWrapper extends ServletContainer {
         JERSEY_LOGGER.setLevel(Level.SEVERE);
         config = new HashMap<String, Object>();
         config.put(RESOURCE_CONFIG_CLASS_KEY, RESOURCE_CONFIG_CLASS);
+        config.put("com.sun.jersey.api.json.POJOMappingFeature", true);
+        
         prc = new PackagesResourceConfig(SCAN_PACKAGE_DEFAULT);
         prc.setPropertiesAndFeatures(config);		
         prc.getProperties().put(CONTAINER_RESPONSE_FILTERS, CORSFILTER);
@@ -95,6 +94,7 @@ public class JerseyWrapper extends ServletContainer {
         prc.getClasses().add(MsgArchiveService.class);
         prc.getClasses().add(StatisticsService.class);
         prc.getClasses().add(MessageService.class);
+        prc.getClasses().add(SecurityAuditLogService.class);
 
         prc.getClasses().add(RESTExceptionMapper.class);
     }

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/service/SecurityAuditLogService.java

+package org.jivesoftware.openfire.plugin.rest.service;
+
+import javax.annotation.PostConstruct;
+import javax.ws.rs.DefaultValue;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.MediaType;
+
+import org.jivesoftware.openfire.plugin.rest.controller.SecurityAuditLogController;
+import org.jivesoftware.openfire.plugin.rest.entity.SecurityAuditLogs;
+import org.jivesoftware.openfire.plugin.rest.exceptions.ServiceException;
+
+@Path("restapi/v1/logs/security")
+public class SecurityAuditLogService {
+
+	private SecurityAuditLogController securityAuditLogController;
+
+	@PostConstruct
+	public void init() {
+		securityAuditLogController = SecurityAuditLogController.getInstance();
+	}
+
+	@GET
+	@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
+	public SecurityAuditLogs getSecurityAuditLogs(@QueryParam("username") String username,
+			@QueryParam("offset") int offset,
+			@DefaultValue("100") @QueryParam("limit") int limit, @QueryParam("startTime") long startTime,
+			@QueryParam("endTime") long endTime) throws ServiceException {
+
+		return securityAuditLogController.getSecurityAuditLogs(username, offset, limit, startTime, endTime);
+	}
+}

src/plugins/restAPI/src/web/rest-api.jsp

@@ -181,7 +181,7 @@
 
                 <p>You can find here detailed documentation over the Openfire REST API: 
                     <a
-                        href="/plugin-admin.jsp?plugin=restapi&showReadme=true&decorator=none">REST
+                        href="/plugin-showfile.jsp?plugin=restapi&showReadme=true&decorator=none">REST
                         API Documentation</a>
                 </p>
             </div>