axis-security.html

<script type="text/x-red" data-template-name="Axis Security">
    <div class="form-row">
        <label for="node-input-preset"><i class="icon-tag"></i> Device</label>
        <input type="text" id="node-input-preset">
    </div>
  
	<div class="form-row">
        <label for="node-input-action"><i class="icon-tag"></i> Action</label>
        <select id="node-input-action">
            <option value="List accounts">List accounts</option>
            <option value="Set account">Set account</option>
            <option value="Remove account">Remove account</option>
            <option value="Allow discovery">Allow discovery</option>
            <option value="Allow SSH">Allow SSH</option>
            <option value="Set SSH User">Set SSH User</option>
            <option value="Allow Browser Access">Allow Browser Access</option>
            <option value="Set firewall">Set firewall</option>
            <option value="List certificates">List certificates</option>
            <option value="Generate CSR">Generate CSR</option>
            <option value="Install Certificate">Install Certificate</option>
            <option value="Remove Certificate">Remove Certificate</option>
            <option value="Set HTTPS certificate">Set HTTPS certificate</option>
		</select>
	</div>
	
</script>

<script type="text/javascript">
RED.nodes.registerType('Axis Security',{
	category: 'Axis',
	color: '#FFCC33',
	defaults: {
		name: { value:""},
		preset: {type:"Device Access"},
		address: {value:""},
		action: { value:"List accounts"},
		data: { value:""},
		options: { value:""}
	},
	icon: "font-awesome/fa-shield",
	inputs:1,
	outputs:1,
	label: function() {
		return this.name || this.action || "Axis Security";
	},
	oneditprepare: function() {
		$("#node-input-action").change(function() {
			var action = $("#node-input-action").val();
			$(".input_options").hide();
			$(".input_data").hide();
			$(".input_account").hide();
			switch (action) {
				case "List accounts":
				break;
				case "Set account":
				break;
				case "Remove account":
					$(".input_account").show();
				break;
				case "Remove Certificate":
					$(".input_data").show();
				break;
				default:
			}
		});
	}
});
</script>

<script type="text/x-red" data-help-name="Axis Security">

	<h2>Inputs & Outputs</h2>
	Set the device and call an action.
	Action will only output on success.  Use a Catch node to get detailed errors.
	
	<br/><br/>

	<p>
		<b>List accounts</b><br/>
		Get all accounts
	</p><br/>

	<p>
		<b>Set account</b><br/>
		Adds or updates an account.  Valid privilege levels are Viewer, Operator and Admin.<br/>
			<code>msg.payload</code><br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">object</span></dt>
			<dd>
				{<br/>
				&nbsp;&nbsp;"name":"",<br/>
				&nbsp;&nbsp;"password":"",<br/>
				&nbsp;&nbsp;"privileges":"Admin"<br/>
				}<br/>
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Remove account</b><br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">string</span></dt>
			<dd>
				Account name
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Allow discovery</b><br/>
		Enable or disabled discovey protocols (UPnP, Bonjour and Link-local)
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">boolean</span></dt>
			<dd>
				true or false
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Allow SSH</b><br/>
		Enable or disabled ability to connect terminal over SSH (Secure Shell)<br/>
		Only for advanced maintence.  Recommended to disable during daily operations.
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">boolean</span></dt>
			<dd>
				true or false
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Set SSH User</b><br/>
		Set or update SSH User.  SSH must be enabled for users to access.<br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">object</span></dt>
			<dd>
				{<br/>
				&nbsp;&nbsp;"user":"name",<br/>
				&nbsp;&nbsp;"password":"password",<br/>
				&nbsp;&nbsp;"comment":"optional",<br/>
				}</code><br/>
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Allow Browser Access</b><br/>
		Enable or disabled ability access device with a Browser<br/>
		Does not affect the device API for VMS or other clients. Recommended to disable during daily operations.
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">boolean</span></dt>
			<dd>
				true or false
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Set firewall</b><br/>
		Limit connections to only trusted clients and service address.<br/>
		Add multiple trusted client address to minimize locking yourself out.<br/>
		All trusted connections needs to be added including outgoing connections such NTP, DNS and MQTT.  Use the Axis Device node to list all current connections and they should be added in the list.
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">array</span></dt>
			<dd>
				List of at least two white listed IP addresses.  An empty list will whitelist all connections.<br/>
				["1.2.3.4.5","2.3.4.5",...]
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>List certificates</b><br/>
		List all installed certificates<br/>
	</p><br/>

	<p>
		<b>Generate CSR</b><br/>
		Generate a CSR (Certificate signing request) to be signed by a CA.<br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">object</span></dt>
			<dd>
			{<br/>
			&nbsp;&nbsp;"CN":"host.domain.com",<br/>
			&nbsp;&nbsp;"C":"US",<br/>
			&nbsp;&nbsp;"O":"Acme Inc"<br/>
			&nbsp;&nbsp;"ST":"State or province name"<br/>
			&nbsp;&nbsp;"days":365<br/>
			}<br/>
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Install Certificate</b><br/>
		Install a CA-signed certificate<br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">string</span></dt>
			<dd>
			Certificate as PEM format
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Remove Certificate</b><br/>
		Remove an unused certificate (not currently used by HTTPS or 802.1x<br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">string</span></dt>
			<dd>
			Certificate ID from List Certificate
			</dd>
		</dl>	
	</p><br/>

	<p>
		<b>Set HTTPS certificate</b><br/>
		Installs a CA-signed certificate and configure HTTPS to use it<br/>
		<dl class="message-properties">
			<dt>msg.payload<span class="property-type">object</span></dt>
			<dd>
				{<br/>
				&nbsp;&nbsp;"cert":"PEM data",<br/>
				&nbsp;&nbsp;"key":"PEM data"<br/>
				}</code><br/>
			</dd>
		</dl>	
	</p><br/>

	<dl class="message-properties">
		<dt>Options<span class="property-type">string | object | buffer</span></dt>
		<dd>Depends on action<br/>
		Use <code>msg.options</code> to override config.
		</dd>
	</dl>	

	<dl class="message-properties">
		<dt>Data<span class="property-type">string | object | buffer</span></dt>
		<dd>Depends on action<br/>
		Use <code>msg.payload</code> to override config.
		</dd>
	</dl>	

	<h3>Outputs:</h3>
	<dl class="message-properties">
		<dt>msg.error<span class="property-type">bool | string</span></dt>
		<dd>On success, error will be <code>false</code><br/>
		On failure, error will be <code>true</code> or message string</dd>
	</dl>	

	<dl class="message-properties">
		<dt>msg.payload<span class="property-type">bool | string | buffer</span></dt>
		<dd>Depends on action</dd>
	</dl>	

</script>