2 - Basics/Advanced Configuration
Initial Set Up Actions
First and most important, you need to create your Server Identity Account. The site account is required to register PK Endpoint Manager with PKWARE and is also used for acquiring licenses from the PK Protect Cloud.
After getting your site registered with PKWARE and the PK Protect Cloud, configuring access to the Active Directory domain controller is required. As covered in the Windows Server: Installation and Setup Guide, the PK Protect Manager needs to be running in Internet Information Server (IIS) on a Windows Server machine joined to the domain you are using for your organization. If you have several domain controllers and/or need to provide authentication to access Active Directory Domain Services, you can configure PK Protect to use a specific domain controller or set or credentials.
As your users begin to use PK Protect and Smartkeys, notifications and alerts can be sent via email. These emails will alert a user to a request for access to a Smartkey. The requester will receive an email when access is granted, and the owner of the Smartkey will receive an email alerting them to the pending request. To get email notifications set up within your organization, just configure the mail settings on the Basics page.
PK Endpoint Manager Approval System
PEM has a two-approval-based system for processing some change requests (such as adding new admins, deleting admins and editing policies). This means as one system administrator makes changes, more than likely another system administrator will need to approve this action. This two-approval system helps prevent from a bad actor making changes without review or approval.
When a new change request is generated, the Actions tab will show an alert (like in the example above).
Description: A short explanation of the action\change that is pending,
Created By: The administrator who generated this change request.
Created: The date and time the change request was generated.
Approve - Approve the change.
Cancel - Denies the request. The denial is recorded; the request is added to the record.
Delete - Erases the existence of the request from the system.
Viewing the Server Status
PKWARE Support uses the Server Status information to diagnose incidents and problems. Server Status provides a read-only view to the versions of your PK Endpoint Manager application and database. The Support field allows you to download a Diagnostic Package with server or user logs in a .ZIP file. When contacting PKWARE for support, please include this package.
Click Server Support to download current logs for this PK Endpoint Manager instance.
Click User Support and select a system user to download logs for that user.
Before registering the PK Endpoint Manager, configure your Keystore. By default, PK Protect selects the local keystore configured during the install. Click the pencil to select from a Trusted Security Foundation if you are integrating PK Protect with QLabs, or a PKCS#11-based keystore. Paste your PKCS#11 keystore configuration file in the provided area.
Registering the PK Protect Manager
The PK Endpoint Manager needs to be registered before it can function. The registration process alerts PKWARE that your PEM is online and ready for activation and licenses. A Public URL is required in this process to direct future traffic to this PEM. Once the PEM is registered with PKWARE, all users with a PK Protect-associated email domain will be directed to use the server for all PK Protect actions.
|Company Name||Your company name. Click the pencil to edit this.|
|Identity (email address)||Your PK Endpoint Manager connects to the PK Protect Cloud for licenses and updates through the Identity email. This account also facilitates key management to external users through the PK Protect Cloud. |
|Public URL||The external URL for the server. For those who are accessing your PEM outside of your network, this value is the publicly routable DNS entry.|
|Account Created||Is there a site account? When you have created a site account, this field displays Yes. If not, you must create one. See Creating an Online Account and Creating an Isolated Account for differences in the account types.|
|Account Logged In||Connected to PK Protect Cloud (online) or Isolated site account created (isolated).|
|Account Registered||Domain account is registered.|
|Authorized for PDE||This is the basic PK Protect service. Your account will zip and encrypt sensitive data based on policy.|
|Authorized for TDE||Server has Transparent Data Encryption (TDE) enabled.|
|Authorized for Multi-tenant||This feature permits compartmentalizing administration of a TDE server.|
|Authorized for TDE Desktop|
|Authorized for Application SDK||The PK Protect Software Development Kit permits creating custom applications for PK Protect.|
|Authorized Domains||Domain name(s) allowed to access this PK Protect Manager. This will be completed after the initial account is created on the PK Protect Cloud. The list also controls which users are authorized users and Guest Accounts.|
Creating an Online Account
Creating an online account will allow your PK Endpoint Manager to periodically sync with the PK Protect Cloud.
Create an online account if...
- You would like to allow internal users in your PK Protect environment to create and use Smartkeys with people outside the organization (external users).
- You would like external users to create and use Smartkeys with internal users.
- You would like to automate the site registration and license acquisition process.
Note: Regardless of whether you choose and Online or Isolated account, Internal users (people inside your organization) can always exchange Smartkey-encrypted files with each other. Depending on the policies you set, internal users can also exchange data encrypted with passphrases or public keys (X.509 or OpenPGP). You must create an online account to use Smartkeys with people outside your organization.
Registering an Online Server
To complete an online registration, just click the Create Account Online button after filling in the registration details. Your account will be created in the PK Protect Cloud and licenses will be synced down to your environment after the PK Protect Cloud defines them for your site.
Creating an Isolated Account
Creating an isolated account will configure the PK Endpoint Manager to not sync with the PK Protect Cloud. Registration and licensing is completed in a manual out-of-band communication. You will need to export some JSON data and send it to PKWARE. Then PKWARE will send back JSON data to import.
Create an isolated account if...
- You will never allow PK Protect users to use Smartkeys with external users.
- You would like your PEM to not connect to the PK Protect Cloud.
Note: Regardless of whether you choose and Online or Isolated account, Internal users (people inside your organization) can always exchange Smartkey-encrypted files with each other. Depending on the policies you set, internal users can also exchange data encrypted with passphrases or public keys (X.509 or OpenPGP).
Registering an Isolated Server
- Under App Registration, enter a site registration fields.
- Click Create Account Isolated. This button creates the site account and logs it in to the database. The Logged In field will read Yes (Isolated mode).
- Click the Export Satellite Identity link that appears. You will be taken to a separate screen to download a server registration file.
- Copy and send that file back to PKWARE to register your PK Endpoint Manager.
- PKWARE will generate an authorization file and send it back to you.
- Click Import Authorizations and specify the location of the authorization file from step 5.
Importing an Isolated Server License
As with the registration code, PKWARE will provide a license key to permit your company to use PK Protect (Server and Client). To install this code and make PK Protect operational:
- Copy the license text.
- Go to Advanced > Licenses .
- Click Import License.
- Paste the license text into this page.
- Click Import License.
The license will appear under Active Licenses.
General Configuration Options
You can configure many PK Endpoint Manager processes here. Some settings control client activities, while others define how PK Protect Manager interacts with its ecosystem.
External Polling Interval (seconds)
How often (in seconds) PK Endpoint Manager connects to the PK Protect Cloud to receive changes. Default is 60. Click the pencil to edit this interval.
Internal (Agent) Polling Interval (seconds)
How often the PK Protect clients deployed in your organization will check with the PEM for changes. The changes could be new Smartkeys, new policy changes, or account access changes.
|Administrator Idle Session Timeout (minutes)||Use this field to specify when (in minutes) the server should automatically logout an administrator's session. The default (999) is unlimited.|
|Enable Service API||Sometimes you may need to have the PK Protect Manager online, but not accessible to all the clients. The most common time you may need this is when migrating servers, or when performing upgrades on components. When you say No, only connections from the system will be accepted. External web requests will be rejected. Applies to all PEMs in a cluster.|
|Local Enable Service API||Sometimes you may need to have the PK Protect Manager online, but not accessible to all the clients. The most common time you may need this is when migrating servers, or when performing upgrades on components. When you say No, only connections from the system will be accepted. External web requests will be rejected. Applies only to the PEM this setting is changed on.|
|Local Database Paused||Use this for troubleshooting. When you click Yes, database access is temporarily suspended. All current users are logged out. Only locally defined administrator accounts are available.|
|API Throttle Percentage||When configured, the percentage of agents which will be allowed to log into PK Protect. Use when extreme load is preventing administrators from connecting to the PEM during troubleshooting.|
|Manager Allowed IP Addresses||Identify IPv4 addresses for a whitelist.|
Data Security Intelligence
Data Security Intelligence enables PK Protect clients deployed in your organization to report back to the PEM a file audit log. It will transmit file encryptions, decryptions and different Smartkey access control list changes. See the Reporting (DSI) page for detailed documentation.
This feature will collect data about how your users are using the system. Each file encryption and decryption is logged, so leaving this option enabled without interest in this feature will cause your database to grow very large very fast.
|Enabled||Server will perform Data Security Intelligence functions.|
|Signing||Clients will transmit information about digitally-signed files as well as encryptions.|
|Target||Identifies where DSI data will be sent. Identify an internal location, a Splunk server, or an appropriate system log.|
|Dashboard Elasticsearch Target||To include DSI events in the Dashboard view, click here and check Enable DSI in Dashboard. You can choose the target set in the previous line, or choose a different URL.|
|Log all Agent Activity (forensic)||Clients will transmit information everything each client does.|
|Log Unencrypted Archive Events||Clients will transmit information about all archives created and extracted, even when the archive is not encrypted.|
|Log Multi-file Archive Events|
Clients will transmit information about all archives created and extracted containing more than one file.
|Log Device Last Access Times||Clients will transmit when a device was last accessed.|
|Log Admin Login Attempts||Clients will transmit when an attempt to login to that device as an administrator.|
Configuring the PK Endpoint Manager to connect to your mail server
As your users begin to use PK Protect and Smartkeys, notifications and alerts can be sent via emails. These emails will alert a user to a request for access to a Smartkey. The requester will receive an email when access is granted, and the owner of the Smartkey will receive an email alerting them to the pending request. To get the email notifications setup within your organization, just configure the mail settings.
Require mails to be secure
Mail Server hostname
25 by default, unless TLS enabled
If your mail server requires authentication, identify the Active Directory Domain here.
(Optional) If your mail server requires authentication, enter the Active Directory user name.
(Optional) If your mail server requires authentication, enter the Active Directory user password.
Enter what should appear in the From: line when PK Endpoint Manager sends log reports
System Event Recipients
Enter the email addresses for people who should be notified when high priority errors occur on PEM.
Billing Event Recipients
PEM checks periodically for license consumption usage and will notify this person when the allocated license count is reached and when the system will stop distributing new licenses to PK Protect clients.
When you have configured the Mail Settings, click Send Test Mail to confirm that everything works.
Configuring the PK Endpoint Manager to use Memcached
As your environment may be very large, we recommend running different PEM application servers behind a load balancer. Using and configuring a load balancer will help the system scale to handle more HTTPS traffic from the clients in your organization. This type of configuration is for large-scale deployments where the PEM would be needed to serve 100,000 clients throughout an organization. Memcached is required when using more than one PEM in an application server cluster. When Memcached is configured, it will store data in itself, instead of in memory on the single PEM. Memcached can be configured to be accessed from multiple application servers to create a shared cache pool.
Defaults to No. Only required to enable if you need more than one PK Endpoint Manager in your cluster
This is a combination of the server address and the port that Memcached is installed and running on. It is important to verify that your PK Endpoint Manager has the correct ports opened on through any possible firewall.