Using the Halo Portal
The Halo portal is your view into your organization's Halo account and your control panel for managing it. the portal gives you access to all Halo features, activities, and information that you are authorized to view or manipulate.
Note also that only your account's information appears; you can see nothing of other Halo accounts, just as other accounts' users can see nothing of yours.
Depending the type of Halo user you are, you may be able to use the portal to
- Manage your password and account.
- Invite others to become Halo users within your account.
- Set Halo server groups, install Halo agents, and assign servers to groups.
- Use Halo features to protect your servers' configurations, firewalls, file integrity, exploit resistance, or user access.
- Manage the site settings for your Halo account—for example, configure security settings or manage API keys.
- Create security policies that define issues to track, events to log, and alerts to send.
- Review scan results for detected security issues and logged events.
- Use this information to perform remediations or initiate incident response procedures, as indicated.
This section shows you how to perform the above tasks and more.
Note: If you are interested in a highly abbreviated tutorial to get you started with Halo, consider the Halo QuickStart.
Log Into the Portal
You start using Halo by logging into the Halo portal. Depending on your organization's policies, you will log in using either password authentication or two-factor authentication.
- Use your browser to log into the Halo portal, at https://portal.cloudpassage.com. The portal login page appears:
- Enter your Halo username and password.
- Click Submit.
For multi-factor authentication only:
After you enter your username and password, the Multi-Factor Authentication page for either SMS or YubiKey appears. (If you are enabled for both types of authentication, the page allows you to choose which to use.)
Authorize your browser:
To ensure enhanced security for Halo portal access, Halo users are in most cases required to register the individual web browser instances that they use to log into the Halo portal.
- If this is your first time logging into the portal, click Yes to authorize the browser you are using.
If you click Yes, you will be logged in and the browser will be authorized for 30 days, during which time you will not be challenged to provide an authorization code. If you click No, you will be logged in but the browser will not be authorized for future logins.
- If this is not your first login but you are logging in from a browser that is not already authorized, register that browser by entering an authorization code that Halo sends to you separately (by email).
- If the code is not accepted, you cannot log in.
- If the code is accepted, you will be logged in and the browser will be authorized for 30 days.
- If the code is accepted but you have cleared the Remember this device for 30 days checkbox, you will be logged in but the browser will not be authorized for future logins.
You can have any number of authorized browsers at any moment, but all authorizations last for 30 days only.
Note: All Halo users that use only username and password for Halo login must also use browser authorization. For those that use multi-factor authentication or single sign-on for Halo login, browser authorization is optional and can be disabled on the Authentication Settings tab of the Site Administration page of the Halo portal. Nevertheless, CloudPassage recommends that it remain enabled for all users.
If your password or multi-factor authentication is successful, the login is complete and the Halo Dashboard page appears.
- From the Dashboard, use the links and menus to access any of your available Halo features and information.
Besides logging into the portal, you can also use the login page to reset your Halo password or even to register for Halo if you aren't yet a user.
Note: Certain aspects and requirements for your organization's Halo login process are under the control and responsibility of your Halo site administrator(s). If you are a site administrator, see Authentication Settings for an explanation of the settings that you can modify. See also Advanced Settings if you need to control the IP addresses from which Halo users are permitted to log in.
Whenever you are logged into the Halo portal, help with learning or using Halo is always just a few clicks away.
- Select Support > Getting Started With Halo to view a short document that walks you through using Halo.
- Select Support > File Support Request to contact CloudPassage Customer Support for help.
- Select Support > Documentation and Forums to open the following dialog box:
- To look up information about Halo, click Browse Documentation or Browse Support Forums to peruse the documents in the Customer Support forums, including the Halo product documentation. See About the Support Forums for more information.
- To search for documentation on a specific topic, enter the topic into the field and click Search. Links to relevant forum and documentation articles containing that term appear below the search box:
- If instead you want to file a request for help with Customer Support, click File a Support Request. The New Support Request form opens:
Fill in the fields of the form and click Submit. A support ticket for you is entered into the system. The support team will contact you by email within 24 hours.
About the Support Forums
CloudPassage sponsors a number of user forums on the CloudPassage Support Community site. These forums are open to the public and are a great source of information and ideas on how to learn and use CloudPassage Halo. There are over 25 active forums, in the following categories:
- Product Updates. Several forums, including "Release Notes" and "Customer Notifications".
- Documentation. About a dozen forums, one for each available product guide.
- Frequently Asked Questions. Several forums answering questions about Halo in general.
- Feature FAQ. Forums answering specific questions about specific Halo features.
- Tips and Tricks. Videos and insider insights from CloudPassage developers on how to harness the power of Halo.
All documents in the forums are indexed for searching, making answers easy to find. You can also submit your own questions, ideas, tips, and articles in the forums to help your fellow users or to receive help yourself.
Note: The Halo product team periodically runs beta programs on new features and content. If you'd like to become one of our next beta testers, email us at email@example.com.
Change Your Password
When you need or wish to change your Halo password, you can do that from within the Halo portal by selecting My Account from the User menu (your name in the page header).
The Password Reset section of your account page lists your organization's password requirements (modifiable by a site administrator; see Halo Site Administration). It also includes fields for entering your current and requested new password. Enter the information and click Save to submit the change request.
Note that you can also request a new password without being logged into the portal. Click Reset your password on the portal login page and follow the instructions.
Manage Your Account and Subscription
To review or edit the details of your Halo account, select My Account from the User menu (your name in the portal page header). There you can view or change your username, first and last name, and time zone. And you can choose to stop receiving daily status emails from CloudPassage, if you wish.
- Note that you can't change your email address on this page. If you need to associate a different email address with your account, contact a Halo site administrator within your organization. If you are a site administrator, you can change your own email address and the email addresses of other users on another page; see Edit an Existing User.
- You can also reset your Halo password from this page, as described in Change Your Password.
If you are a Halo site administrator, you can also see the details of your Halo subscription. Select Manage Subscription from the Site Administrator menu (the gears icon [ ] in the portal page header).
If the Manage Subscription page is available to you, you can use it to
- See the type of your billing plan (Halo or Halo Evaluation) and your billing method, and view your invoices.
- View your server-hour usage for the current billing period.
- Cancel your Halo account.
Halo standard users (non-site-administrators) do not have access to the Manage Subscription page.
Note: Your organization's Halo account may be registered directly with CloudPassage, or it may be registered with a third party that manages your security services through a CloudPassage master account. If you are a Halo site administrator, you have the ability to link your account to a master account or disconnect from that master account. See Master Account for more information.
Invite and Manage Halo Users
If you are a Halo site administrator, one of your privileges is the ability to add other users to your Halo account. (Other site-administrator responsibilities are described in Halo Site Administration.)
Having multiple users allows you to spread responsibility for separate Halo tasks (such as server-group administration versus policy design versus security-event response) across multiple specialists in your organization.
Select Site Administration from the Site Administrator menu (the gears icon in the portal page header), then select the Users tab. The User Administration table displays information about all current Halo users in your organization. If there are many users, the list may break across several pages. You can sort the list by any of the columns, and you can search for a value that appears in any column.
- If you want to add a new Halo user to the account, click Invite New User (see next).
- If you want to delete or deactivate a user, see Deactivate or Delete a User.
- If you want to edit the information for an existing user, click Edit for that user. (See Edit an Existing User.)
Invite a New User
When you click Invite New User on the User Administration page, the following page appears. You "invite" a user because the candidate receives an email invitation from Halo, and the user account is not active until the invitee accepts by logging into the portal.
- To prepare the invitation, start by filling in the required personal information about the invited user.
Note that the username must be unique among all Halo users. A good way to ensure a unique name is to use your email address as your username.
- Decide whether to enable portal access for the user. (A server administrator who will use Halo only for multi-factor network authentication to servers—called GhostPorts in the Halo portal—will not need portal access.)
If the user is to have portal access, decide whether it is to be as a standard user or as a site administrator. The following table explains the differences.
Portal access Site administrator Standard user GhostPorts-only View the Halo Dashboard ✓ ✓ View Security Events History, Scan History ✓ ✓ Run scans ✓ ✓ Install agents (can access Daemon Registration Key) ✓ Manage the Halo subscription ✓ Administer the Halo site (see Halo Site Administration) ✓ Manage "My Account" ✓ ✓ Open GhostPorts ✓ ✓ ✓ Manage policies, exceptions, alert profiles ✓ ✓ Access Halo Customer Support ✓ ✓
- Decide whether to enable multi-factor authentication for the user. There are two reasons for doing this:
- The user will be using multi-factor network authentication (GhostPorts) to log onto to one or more Halo-protected servers. See Multi-Factor Network Authentication Setup Guide for details on why and how to use multi-factor network authentication.
- The user will be logging into the Halo portal with multi-factor authentication. See Multi-factor authentication for details on enabling it for your Halo users.
To enable multi-factor authentication, first specify the user's authentication method. Select SMS code and Halo Password, YubiKey and Halo Password, or both. The page expands to display additional fields.
- Enter the required information into the fields. For detailed instructions, see Enable Multi-Factor Authentication for a User.
- Select the GhostPorts checkbox if you want to enable GhostPorts access for the user, and have already enabled multi-factor authentication.
- Click Invite to commit your settings and close the Invite New User page. The user will receive the invitation by email.
Edit an Existing User
When you click Edit for a Halo user listed on the User Administration page, the following page appears. Note that on this page you can change only the following:
- The user's email address
- The user's multi-factor authentication enablement
- The user's portal access and user type
- The user's GhostPorts enablement
See the descriptions of those fields in the previous section (Invite a New User) if you need more information.
Users can themselves view and change other information about their accounts on a different page; see Manage Your Account and Subscription for details.
Deactivate or Delete a User
The Halo portal gives you two ways to remove a Halo user from your organization's Halo account:
- You can deactivate the user if he or she is no longer using Halo and is not expected to return to active status in the near future. The user can no longer log into the portal, but the user's name remains (marked "deactivated") on the list of Halo users on the Site Administration page, the user's profile information is retained, and the user can easily be re-activated by a Halo Site Administrator.
To deactivate a user, locate the user's name in the table on the Users tab of the portal's Site Administration page, then click Deactivate for that user in the Status column.
- You can delete the user if it is certain that the user will never be re-activated, and if it is appropriate to destroy all information about the user. A deleted user is not listed on the Site Administration page and cannot be re-activated; however, all historical information about the user is retained in the Halo database for audit purposes.
To delete a user, locate the user's name in the table on the Users tab of the portal's Site Administration page, then click Delete for that user in the Status column.
// <![CDATA[ var pdfTitle="Halo Operations Guide"; var pdfURL="http://www.cloudpassage.com/document_images/ops/halo-operations.pdf"; specifyPDF(pdfTitle, pdfURL); // ]]>