.. _services: Services ======== .. _service_types: Service Types ------------- There are three types of service checks in IScorE: Standard Checks, Mass Checks, and Multi-Protocol Checks. Multi-Protocol Checks ^^^^^^^^^^^^^^^^^^^^^ Multi-Protocol checks are special checks that choose which Standard Check they are going to use for a team based on a defined criteria (usually port number). For example, the "Remote Admin" check included with IScorE will use SSH to check the service if the port is 22 and RDP to check the service if the port is 3389. Mass Checks ^^^^^^^^^^^ Mass checks are designed to check all teams at once. These are most useful when an external system is calculating the scores for a custom type of service. This is an advanced feature, and is not needed in the vast majority of situations. .. _add-service: Add Service ----------- 1. On the left side-bar menu, click "Admin Area" if it is an option. 2. On the left side-bar menu, click on "Services". A page like the one below will appear. .. image:: images/service_list.png 3. Click on the blue "Add Service" button in the upper right corner. A form like the one below will appear. .. image:: images/service_edit.png 4. Enter in the fields in the form. Below are descriptions of each field. Name Name of the service. E.g. WWW HTTP Maximum Score Maximum score for this service Protocol Protocol to use URL URL to check for each team. Insert ``%s`` in place of team number or ``%d`` for the team's :ref:`custom domain `. E.g. ``www.team%s.`` Port Port to use External Indicates that this is an :ref:`external check ` that will not be run by the service scanner. Username Username that will be used. Password Password that will be used. Team-specific Password Team-specific password to use, if applicable. Team-specific Password Pool Which :ref:`team-info-pools` to use, if applicable. HTTP String Check Only applicable for HTTP/HTTPS checks. Verifies that the string appears on the webpage. Score Released Whether the score will be available to Blue Teams. Visibility Settings A series of checkboxes indicating the whether the service check is visible to the which groups. 5. Click the blue "Submit" button in the bottom right corner. .. _edit-service: Edit Service ------------ 1. On the left side-bar menu, click on "Admin Area". 2. On the left side-bar menu, click on "Services". A page like the one below will appear. .. image:: images/service_list.png 3. Click on the white "Edit" button next to the service you want to edit. A form like the one below will appear. .. image:: images/service_edit.png 4. Change the desired values. .. warning:: Due to the way services are stored, the details in this form are pulled from the service definition of the first team. This means that the URL will always be the same as the URL for the first name, **NOT** the pattern that was entered when the service was created. If you do not wish to change the URL, **do not** click in the field as the rest of the teams are updated when the main URL field is changed. 5. Click the blue "Submit" button in the bottom right corner. 6. Remember, some changes will not appear on the service scanner until the next scan. .. note:: If you increase the score of a check, passing checks will turn yellow (partial credit) until the next service scan. .. _delete-service: Delete Service -------------- 1. On the left side-bar menu, click "Admin Area". 2. On the left side-bar menu, click "Services". A page like the one below will appear. .. image:: images/service_list.png 3. Click on the red "Delete" button next to the service you want to remove. A message box asking to confirm the deletion will appear. 4. Confirm the deletion by clicking the red "Delete" button.