Skip To Content

Scan your portal for security best practices

The ArcGIS Enterprise portal comes with a Python script tool, portalScan.py, that scans for common security issues. The tool checks for problems based on some of the best practices for configuring a secure environment for your portal. It analyzes many criteria or configuration properties and divides them into three severity levels: Critical, Important, and Recommended. The descriptions of these criteria are as follows:

IDSeverityPropertyDescription

PS01

Critical

Proxy restrictions

Determines if the portal proxy capability is restricted. By default, the portal proxy server is open to any URL. To mitigate against potential Denial of Service (DoS) or Server Side Request Forgery (SSRF) attacks, it's strongly recommended that you restrict the portal's proxy capability to approved web addresses.

PS02

Critical

Token requests

Determines if generate token requests with credentials in the query parameter are supported. If supported, when generating tokens, a user's credentials could be provided as part of the URL and may be exposed through browser history or in network logs. This should be disabled unless required by other applications.

PS03

Important

Portal services directory

Determines if the portal services directory is accessible through a web browser. This should be disabled to reduce the chances that your portal items, services, web maps, groups, and other resources can be browsed, found in a web search, or queried through HTML forms.

PS04

Important

Secure communication

Determines if the portal communicates through HTTPS only. To prevent the interception of any communication within the portal, it's recommended that you configure your portal and the web server hosting the Web Adaptor to enforce SSL.

PS05

Recommended

Built-in account sign-up

Determines if users can click the Create An Account button on the portal sign-up page to create a built-in portal account. If you're using enterprise accounts or you want to create all accounts manually, disable this option.

PS06

Recommended

Anonymous access

Determines if anonymous access is allowed. To prevent any user from accessing content without first providing credentials to the portal, it's recommended that you configure your portal to disable anonymous access.

PS07

Recommended

LDAP identity store

If the portal is configured with an LDAP identity store, this determines if encrypted communication is used. It is recommended that you use LDAPS in the ldapURLForUsers and ldapURLForRoles properties listed in the user store and group store configuration parameters.

PS08

Recommended

Portal SSL certificate

Determines if a self-signed certificate is used by the portal. To help reduce web browser warnings or other unexpected behavior from clients communicating with the portal, it is recommended that you import and use a CA-signed SSL certificate bound to port 7443.

PS09

Recommended

Cross-domain requests

Determines if cross-domain (CORS) requests are unrestricted. To reduce the possibility of an unknown application accessing a shared portal item, it is recommended that you restrict cross-domain requests to applications hosted only in trusted domains.

PS10

Critical

Federated server administrative URL

Determines if your federated server's administrator URL is reachable by the portal and if the SSL certificate used in this URL is trusted. If untrusted or not reachable, many portal functions and operations will fail.

PS11

Recommended

Federated server services URL

Determines if your federated server's services URL is reachable by the portal and if the SSL certificate used in this URL is trusted. If untrusted or not reachable, the portal will still function but some portal operations may fail.

PS12

Recommended

Public content

If the portal is configured so members cannot share content publicly, this will list any items that are still shared with Everyone.

The portalScan.py script is located in the <Portal for ArcGIS installation location>\tools\security directory. Run the script from the command line or shell. You have the option to specify one or more parameters when running the script.

portalScan.py parameters

The following table describes portalScan.py parameters:

ParameterDescription

-n

The fully qualified domain name of the machine where Portal is installed (in other words, gisportal.domain.com). The default is the host name of the machine where the script is run.

-u

The user name of an administrator account.

-p

The password of an administrator account.

-o

The directory where the security scan report will be saved. The default directory is the same folder where you run the script.

-t

A token can be generated and used in place of the user name and password. When generating a token, portalScan should be input in the Webapp URL field. When a token is provided, it overrides any user name or password that is provided.

--ignoressl

Disable SSL certificate verification. Starting in 10.7.1, the script will attempt to verify all SSL certificates by default. If Python does not trust the issuer of the certificates, the script will fail to complete. If needed, this parameter can be specified to ignore all certificates.

-h or -?

Outputs a listing of the parameters that can be specified when running the script.

Example: python portalScan.py -n portal.domain.com -u admin -p my.password -o C:\Temp

If the portalScan.py script is run without specifying parameters, you will be prompted to enter them manually or select the default value. If you want to use a token, it must be provided as a parameter when running the script.

The scan generates a report in HTML format that lists any of the above issues that were found in the specified portal.

By default, the report is saved in the same folder where you run the script and is named portalScanReport_[hostname]_[date].html.


In this topic
  1. portalScan.py parameters