1,244
edits
Changes
Template:Networking rutos manual administration (view source)
Revision as of 15:02, 5 March 2021
, 15:02, 5 March 2021no edit summary
{{Template:Networking_rutos_manual_fw_disclosure
<!--- {{{series}}}, {{{name}}} --->
| fw_version = {{{series}}}_R_00.02.03
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.06.1
| series = {{{series}}}
| series = {{{series}}}
}}
}}
The <b>General</b> section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below.
The <b>General</b> section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below.
{{#ifeq:{{{series}}}|RUTX|[[File:Networking_{{lc:{{{name}}}}}_manual_administration_general_v2.png|border|class=tlt-border]]
|[[File:Networking_{{lc:{{{name}}}}}_manual_administration_general.png|border|class=tlt-border]]}}
<table class="nd-mantable">
<table class="nd-mantable">
<td>-(interactive button)</td>
<td>-(interactive button)</td>
<td>Restores device to custom configuration set by the user.</td>
<td>Restores device to custom configuration set by the user.</td>
</tr>
</tr>
</table>
</table>
==Access Control==
==Access Control==
===General===
===General===
----
The <b>Access Control</b> page is used to manage remote and local access to device.
The <b>Access Control</b> page is used to manage remote and local access to device.
<b>SSH</b>
<b>SSH</b>
----
----
[[File:Networking_rutx_manual_administration_access_control_general_ssh_v1.png]]
[[File:Networking_rutos_manual_administration_access_control_general_ssh.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<b>WebUI</b>
<b>WebUI</b>
----
----
[[File:Networking_rutx_manual_administration_access_control_general_webui_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_access_control_general_webui.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<b>CLI</b>
<b>CLI</b>
----
----
[[File:Networking_rutx_manual_administration_access_control_general_cli_v1.png]]
[[File:Networking_rutos_manual_administration_access_control_general_cli.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
===Security===
===Security===
----
----
[[File:Networking_rutx_manual_administration_access_control_security_v1.png]]
[[File:Networking_rutos_manual_administration_access_control_security.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
</table>
</table>
===Root CA===
----
The <b>Root CA</b> section is used to add a root CA certificate file to the device. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.
[[File:Networking_rutos_manual_administration_access_control_root_ca.png|border|class=tlt-border]]
==Troubleshoot==
==Troubleshoot==
===Logging Settings===
----
The <b>Logging Settings</b> section is used to configure how and where the device stores system log data. The system log is a file that contains information on various system related events and is useful to engineers for troubleshooting the device.
[[File:Networking_rutos_manual_administration_troubleshoot_logging_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>System log buffer size</td>
<td>integer; default: <b>128</b></td>
<td>System log buffer size in kibibytes (KiB).</td>
</tr>
<tr>
<td>External system log server</td>
<td>ip; default: <b>none</b></td>
<td>IP address of an external server that will be used to store device logs.</td>
</tr>
<tr>
<td>External system log server port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>TCP/UDP port number of the external log server.</td>
</tr>
<tr>
<td>External system log server protocol</td>
<td>UDP | TCP; default: <b>UDP</b></td>
<td>Communication protocol used by the external log server.</td>
</tr>
<tr>
<td>Save log in</td>
<td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
<td>Specifies which type of memory to use for storing system logs.</td>
</tr>
</table>
===Troubleshoot===
----
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the device. Refer to the figure and table below for information on the Troubleshoot page.
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the device. Refer to the figure and table below for information on the Troubleshoot page.
[[File:Networking_rutx_manual_administration_troubleshoot_v1.png]]
[[File:Networking_rutos_manual_administration_troubleshoot_troubleshoot.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
===TCP dump===
====TCP dump====
----
----
<b>TCP dump</b> is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.
<b>TCP dump</b> is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
[[File:Networking_rutx_manual_administration_troubleshoot_tcp_dump_v3.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_troubleshoot_tcp_dump.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
The <b>Diagnostics</b> section is used to execute simple network diagnostic tests, including <i>ping</i>, <i>traceroute</i> and <i>nslookup</i>.
The <b>Diagnostics</b> section is used to execute simple network diagnostic tests, including <i>ping</i>, <i>traceroute</i> and <i>nslookup</i>.
[[File:Networking_rutx_manual_administration_diagnostics_v3.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_troubleshoot_diagnostics.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>-(interactive button)</td>
<td>-(interactive button)</td>
<td>Performs diagnostic test when clicked.</td>
<td>Performs diagnostic test when clicked.</td>
</tr>
</table>
==Recipients==
The <b>Recipients</b> section is used to configure{{#ifeq:{{{mobile}}}|0| | phone groups and }}email
users, which can later be used along with{{#ifeq:{{{mobile}}}|0| | SMS or }}email related
services{{#ifeq:{{{events_reporting}}}|0|.|, such as [[{{{name}}} Events Reporting|Events Reporting]].}}
{{#ifeq:{{{mobile}}}|0||
===Phone Groups===
----
A <b>Phone Group</b> is a collection of phone numbers that can be used as the recipient in SMS & call related services instead of specifying every number individually. The phone group list is empty by default thus, you must first add at least one new group before you can add phone numbers to it. To create and begin editing a phone group, follow these steps:
<ol>
<li>Enter a custom name for the phone group into the 'Name' field.</li>
<li>Click the 'Add' button.</li>
<li>Click the 'Edit' button next to the newly added phone group.</li>
</ol>
[[File:Networking_rutos_manual_administration_recipients_phone_groups_add_button_edit_button.png|border|class=tlt-border]]
After clicking 'Edit' you should be redirected to that phone group's configuration page where you can start adding phone numbers to it.
[[File:Networking_rutos_manual_administration_recipients_phone_groups_modify_phone_group.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Group name</td>
<td>string; default: <b>none</b></td>
<td>Name of this phone numbers group.</td>
</tr>
<tr>
<td>Phone number</td>
<td>string; default: <b>none</b></td>
<td>A phone number entry for this group. Numbers that consist of <i>0-9*+#</i> characters are accepted. Click the plus symbol to add more entries.</td>
</tr>
</table>
}}
===Email Accounts===
----
When email related services{{#ifeq:{{{events_reporting}}}|0| | (such as [[{{{name}}} Events Reporting|Events Reporting]]) }}are used, the device logs in to the specified email account and reads the inbox (e.g., Email to SMS) or sends out a message (e.g., SMS to Email) depending on the configured service. In this context, an <b>Email Account</b> is an configuration instance that contains the necessary data required in order to log into an email account.
The email accounts list is empty by default thus, you must first add at least one new account before you can configure it. To create and begin editing an email account, follow these steps:
<ol>
<li>Enter a custom name for the email account into the 'Name' field.</li>
<li>Click the 'Add' button.</li>
<li>Click the 'Edit' button next to the newly added email account.</li>
</ol>
[[File:Networking_rutos_manual_administration_recipients_email_accounts_groups_add_button_edit_button.png|border|class=tlt-border]]
After clicking 'Edit' you should be redirected to that email account's settings page where you can start configuring the account.
[[File:Networking_rutos_manual_administration_recipients_email_accounts_modify_email_account.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Secure connection</td>
<td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
<td>Use if your SMTP server supports TLS or SSL encryption.</td>
</tr>
<tr>
<td>SMTP server</td>
<td>string; default: <b>none</b></td>
<td>Name of the email service provider's SMTP server.</td>
</tr>
<tr>
<td>SMTP server port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Port of the email service provider's SMTP server.</td>
</tr>
<tr>
<td>User name</td>
<td>string; default: <b>none</b></td>
<td>Username used to authenticate to the email service.</td>
</tr>
<tr>
<td>Password</td>
<td>string; default: <b>none</b></td>
<td>Password used to authenticate to the email service..</td>
</tr>
<tr>
<td>Sender's email address</td>
<td>string; default: <b>none</b></td>
<td>Configured SMTP server user's email address.</td>
</tr>
</tr>
</table>
</table>
==Overview setup==
==Overview setup==
The <b>Overview setup</b> section is used to select which widgets will be shown in the [[{{{name}}}_Overview]] window.
The <b>Overview setup</b> section is used to select which widgets will be shown in the [[{{{name}}}_Overview|Overview]] window.
{{#switch:{{{series}}}
{{#switch:{{{series}}}
| RUTX = {{#switch:{{{name}}}
| RUTX = {{#switch:{{{name}}}
| TRB2 = [[File:Networking_trb2_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
| TRB2 = [[File:Networking_trb2_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
| TRB1 = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
| TRB1 = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
|
| RUT36X = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
| RUT30X = [[File:Networking_rut30x_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
}}
}}
==Root CA==
==Certificates==
The <b>Certificates</b> page is used for convenient TLS certificate and key generation and management. Generated files can be exported and used on other machines or locally on this device with functions that use TLS/SSL, such as {{#ifeq:{{{mqtt}}}|0||[[{{{name}}} MQTT|MQTT]], }}[[{{{name}}} VPN#OpenVPN|OpenVPN]], [[{{{name}}} VPN#IPsec|IPsec]] and others.
===Certificate Generation===
----
The <b>Certificate Generation</b> tab provides the possibility to generate TLS certificates required for secure authentication and communication encryption used by some of the devices services.
There are five distinct generation methods (denoted by the selected 'File Type').
<ol>
<li><b>Simple</b> - generates and signs a set of 2048 bit certificate and key files that include:
<ul>
<li>Certificate Authority (CA)</li>
<li>Server certificate & key</li>
<li>Client certificate & key</li>
<li>DH Parameters</li>
</ul>The CA file generated with this option automatically signs the certificates. In short, this option is used for convenience as it doesn't let the user set any additional parameters for the certificate files. Therefore, it should be used only when no other specific requirements are expected.
</li>
<li><b>CA</b> - generates a Certificate Authority (CA) file. A CA is a type of certificate file that certifies the ownership of a public key by the named subject of the certificate. In other words, it assures clients that they are connecting to a trusted server and vice versa.</li>
<li><b>Server</b> - generates a server certificate and key. A server certificate validates a server's identity to connecting clients, while a key is responsible for encryption.</li>
<li><b>Client</b> - generates a client certificate and key. A client certificate validates a client's identity to the server that it's connecting to, while a key is responsible for encryption.</li>
<li><b>DH Parameters</b> - generates a Diffie-Hellman (DH) parameters file. DH parameters are used in symmetric encryption to protect and define how OpenSSL key exchange is performed.</li>
</ol>
====Generation Parameters====
----
Generating each type of file (excluding 'Simple') requires setting some parameters. This section provides an overview for parameters used in TLS certificate generation.
----
<b>Core parameters</b> or simply parameters that apply to each file type are the size and common name of the generated file(s).
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_core_parameters_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Key Size</td>
<td>integer; default: <b>2048</b></td>
<td>Generated key size in bits. Larger keys provide more security but take longer to generate. A 2048 bit is the preferred option.</td>
</tr>
<tr>
<td>Name (CN)</td>
<td>string; default: <b>cert</b></td>
<td>Common Name (CN), aka Fully Qualified Domain Name (FQDN) is a parameter that defines the name of the certificate. It should be chosen with care as it is not only used for easier management. For example, the Common Name should typically hostname of the server. It may also be used to differentiate clients in order to apply client-specific settings.</td>
</tr>
</table>
----
<b>Subject information</b> is not mandatory but can be used as user-friendly way to identify the ownership of certificate files by including such information as the owner's location and company name.
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_subject_information_v1.png|border|class=tlt-border]]
----
The <b>Sign the certificate</b> slider control whether the certificate will be signed automatically or manually after the generation is complete.
[[File:Networking_rutx_manual_administration_root_ca_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_sign_the_certificate_v1.png|border|class=tlt-border]]
==Logging==
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Days Valid</td>
<td>integer; default: <b>3650</b></td>
<td>Length of the signature's validity.</td>
</tr>
<tr>
<td>CA File Name</td>
<td>filename; default: <b>none</b></td>
<td>Selects which CA file will be used to sign the generated certificate.</td>
</tr>
<tr>
<td>CA key</td>
<td>filename; default: <b>none</b></td>
<td>Selects which CA key file will be used to sign the generated certificate.</td>
</tr>
<tr>
<td>Delete Signing Request</td>
<td>off | on; default: <b>off</b></td>
<td>Generation creates additional 'signing request' files (which appear under the [[#Certificate_Manager|Certificate Manager]] tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.</td>
</tr>
</table>
----
A <b>Private Key Decryption Password</b> is a parameter used to decrypt private keys protected by a password.
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_private_key_decryption_password_v1.png|border|class=tlt-border]]
===Certificate Signing===
----
The <b>Certificate Signing</b> section is used to validate (sign) unsigned certificates.
[[File:Networking_rutx_manual_administration_logging_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_certificate_signing_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>System log buffer size</td>
<td>Signed Certificate Name</td>
<td>integer; default: <b>128</b></td>
<td>string; default: <b>cert</b></td>
<td>System log buffer size in kibibytes (KiB).</td>
<td>Name of the signed certificate.</td>
</tr>
<tr>
<td>Type of Certificate to Sign</td>
<td>Certificate Authority | Client Certificate | Server Certificate; default: <b>Certificate Authority</b></td>
<td>Specifies what type of file will be signed.</td>
</tr>
<tr>
<td>Certificate Request File</td>
<td>file; default: <b>none</b></td>
<td>Specifies the signing request file linked to the certificate.</td>
</tr>
<tr>
<td>Days Valid</td>
<td>integer; default: <b>3650</b></td>
<td>Length of the signature's validity.</td>
</tr>
</tr>
<tr>
<tr>
<td>External system log server</td>
<td>Certificate Authority File</td>
<td>ip; default: <b>none</b></td>
<td>filename; default: <b>none</b></td>
<td>IP address of an external server that will be used to store device logs.</td>
<td>Selects which CA file will be used to sign the generated certificate.</td>
</tr>
</tr>
<tr>
<tr>
<td>External system log server port</td>
<td>Certificate Authority Key</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>filename; default: <b>none</b></td>
<td>TCP/UDP port number of the external log server.</td>
<td>Selects which CA key file will be used to sign the generated certificate.</td>
</tr>
</tr>
<tr>
<tr>
<td>External system log server protocol</td>
<td>Delete Signing Request</td>
<td>UDP | TCP; default: <b>UDP</b></td>
<td>off | on; default: <b>off</b></td>
<td>Communication protocol used by the external log server.</td>
<td>Generation creates additional 'signing request' files (which appear under the [[#Certificate_Manager|Certificate Manager]] tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.</td>
</tr>
</tr>
<tr>
<tr>
<td>Save log in</td>
<td>Sign</td>
<td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
<td>- (interactive button)</td>
<td>Specifies which type of memory to use for storing system logs.</td>
<td>Signs the certificate on click.</td>
</tr></table>
</tr>
</table>
===Certificate Manager===
----
The <b>Certificate Manager</b> page displays information on all certificate and key files stored on the device and provides the possibility export these files for use on another machine or import files generated elsewhere.
====Certificate Import====
----
The <b>Certificate Import</b> section provides the possibility to import certificates and files generated on another machine. To upload such a file simply click 'Browse', locate the file on your computer and click 'Import'
[[File:Networking_rutos_manual_administartion_certificates_certificates_manager_certificate_import_v1.png|border|class=tlt-border]]
====Certificates, Keys & Requests====
----
The <b>Certificates</b>, <b>Keys</b> and </b>Requests</b> section display files generated on or imported to the device along with the most important information related to them.
By default, the lists are empty. A set certificates generated using 'Simple' file type would look something like this:
[[File:Networking_rutos_manual_administartion_certificates_certificates_manager_certificate_list_v1.png|border|class=tlt-border]]
The 'Export' buttons are used to download the files from the device onto your local machine. The 'X' buttons located to the right of each entry are used to delete related files.
==Unsaved changes==
==Unsaved changes==
The <b>Unsaved changes</b> section is used to see and apply or revert all unsaved changes.
The <b>Unsaved changes</b> section is used to see and apply or revert all unsaved changes.
[[File:Networking_rutx_manual_administration_unsaved_changes_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_unsaved_changes.png|border|class=tlt-border]]
[[Category:{{{name}}} System section]]
[[Category:{{{name}}} System section]]
