Skip to content

Configuring Offloading, External Sharing and Secure Intake

Last updated

Configuring Offloading for Email and Vault External Sharing and Secure Intake with Microsoft Sharepoint

This configuration allows users within your organization to configure Sharepoint sites so that encrypted content can be stored for Email, sharing files externally with Vault and to request external users to share files to your organization (Secure Intake).  These features all store encrypted content in the designated Sharepoint sites within the customer’s Sharepoint environment and so needs to be configured to ensure both access and security.

This guide walks you through setting up the configuration of both Azure and Sharepoint to support these features.

What you’ll accomplish:

  • Configure Azure applications for secure file access
  • Set up certificate-based authentication
  • Grant appropriate permissions to SharePoint sites
  • Enable Vault Share in your XQ Portal

Before you begin, make sure you have:

  1. Azure Admin Access with ability to grant consent
  2. SuperUser access in XQ Portal
  3. A SharePoint site where Vault files will be stored (this can be a private site with no guest access)
  4. PowerShell 7 installed
    • Windows users: PowerShell 7 will be automatically detected and installed by the makecert.bat script (below) if not present
  5. Certificate generation tools:
    • Windows: The provided makecert.bat script

In this step, you will create two SharePoint sites. One that will be used both for Offloading Email and one that will be used for sharing Vault files externally and for receiving files with the Secure Intake feature. The site should be private (no one can navigate to the site) and the site does not need to be shared externally.

  1. Navigate to your SharePoint admin center
  2. Create a new site
    1. Team Site
    2. Basic Template
    3. Owner: MS Admin
    4. Members: None

One the sites are created, copy the full site URL – you’ll need this later in Step 5 (e.g., https://yourdomain.sharepoint.com/sites/yoursite)

Note: This site can be private and doesn’t require guest access to function with Vault Share.

Step 2: Create Offloading and External Sharing Applications in Azure

Section titled “Step 2: Create Offloading and External Sharing Applications in Azure”

This application will handle authentication between XQ and your SharePoint sites.

  1. Sign into entra.microsoft.com

  2. Navigate to App Registrations → New registration

Azure app registration screen

  1. Configure the registration:
    • Enter a name for your app (e.g., “XQ Offloading”)
    • Set Account Type to Single Tenant
    • Click Register

App registration configuration

  1. After registration, navigate to the application Overview and copy and save:
    • Application (client) ID
    • Directory (tenant) ID

   You’ll need these values later.

  1. Next go to API Permissions → Add a Permission

API Permission Page

  1. Select Microsoft Graph → Application Permissions → Sites.Selected

Request API permissions panel with Application permissions selected, Sites.Selected checked, and Add permissions indicated

After adding the permission, click Grant admin consent.

Note: This step requires admin privileges. You’ll see a green checkmark when consent is successfully granted.

Granted admin consent

Certificate-based authentication provides secure, password-free access for the Vault application. You’ll need to generate certificates that meet Azure’s requirements.

  1. Download this makecert.bat script and place it in a folder (running the .bat script will output the certificates to that folder).
  2. Right click and “Run as administrator” the provided makecert.bat script

Explorer showing makecert.bat file

  1. When prompted:

    • Enter a base site name (default: XQ_Offloading)
    • Enter certificate validity in days (default: 1095 for 3 years)
  2. The script will generate these files:

    • [sitename].key – Private key
    • [sitename].csr – Certificate signing request
    • [sitename].crt – Self-signed certificate
    • [sitename].cer – DER format for Azure
    • [sitename].pem – PEM format for XQ Portal
    • config.json

Command prompt showing successful certificate generation with file names

Note: The script will automatically install OpenSSL if needed and clean up afterward.

If you now have the certificates by following the steps above, you can advance to step 4 below.

  1. Download this makecert.sh script and place it in a folder (running the .sh script will output the certificates to that folder).
  2. Right Click the folder containing the makecert.sh file and select ‘New Terminal at Folder’ (or cd to that folder within Terminal.

macOS Finder right-click menu on the MakeCert folder with New Terminal at Folder highlighted

  1. Run the following command in Terminal:
chmod +x makecert.sh && ./makecert.sh
  1. When prompted:
    • Enter a base site name (default: XQ_Offloading)
    • Enter certificate validity in days (default: 1095 for 3 years)
  2. The script will generate these files:
    • [sitename].key – Private key
    • [sitename].csr – Certificate signing request
    • [sitename].crt – Self-signed certificate
    • [sitename].cer – DER format for Azure
    • [sitename].pem – PEM format for XQ Portal
    • vault-site-wizard.sh
    • config.json
  3. Keep this terminal window open as you will need it in step 6 below.

MakeCert folder in Finder containing config.json, the two scripts, and the generated certificate and key files

Supported Key Algorithms:

  • RSA-2048 (recommended)
  • RSA-3072
  • RSA-4096

Note: ECDSA, EdDSA, and DSA algorithms are not supported by Azure Entra. Keys larger than 4096 bits will be rejected.

Supported Hash Algorithms:

  • SHA-256 (recommended)
  • SHA-384
  • SHA-512

Important: SHA-1 and MD5 are deprecated and will be rejected by Azure Entra.

Certificate Formats:

  • For Azure Entra, upload:
    • .cer file (DER-encoded, public certificate only)
    • .pem file (PEM-encoded, public certificate only)

Note: Azure will not accept files containing private keys.

For XQ Portal, upload:

  • .pem file containing both the certificate and unencrypted private key (concatenated in that order)

Now you’ll upload the public certificate to your Azure app registration.

  1. Return to your Offloading app registration in Azure (this is the app created in Step 2 above).

  2. Go to Manage → Certificates & Secrets

Azure navigation showing Certificates Secrets menu option

  1. Switch to the Certificates tab → Click Upload Certificate
    • Upload the .cer file you created in Step 3

Certificates tab with Upload Certificate button highlighted

  1. Verify the certificate appears in the list with correct expiration date. Your expiration date will be based on the value you entered while running the makecert.bat script in step 3 above.

Certificates list showing newly uploaded certificate

This application will be used to configure permissions on your SharePoint site.

  1. Navigate to App Registrations → New registration
  2. Configure the registration:
    • Enter a name (e.g., “XQ PnP Management”)
    • Set Account Type to Single Tenant
    • Click Register
  3. After registration, copy and save:
    • Application (client) ID
    • Directory (tenant) ID
  4. Go to Manage → Authentication

Authentication settings page

  1. Click Add a platform → Mobile and Desktop Applications

Configure platforms panel with Mobile and desktop applications highlighted

  1. Add Custom Redirect URI: http://localhost

  2. Under Advanced Settings, enable Allow public client flows toggle and click Save

Authentication page with Allow public client flows set to Yes

  1. Go to API Permissions → Add a Permission

  2. Add Sites.FullControl.All (Delegated permission)

Add API Permission

  1. Click Grant admin consent

API permissions page showing Sites.FullControl.All and User.Read granted, with Grant admin consent highlighted

Now you’ll configure which SharePoint sites the Vault application can access.

  1. Locate the config.json file in your installation directory–in the output folder from running the makecert.bat

  2. Open the file and update it with your values:

{
"PnPAppClientId": "CLIENT_ID_FROM_STEP_5",
"PnPAppTenantId": "TENANT_ID_FROM_STEP_5",
"VaultAppClientId": "CLIENT_ID_FROM_STEP_2",
"VaultAppName": "VaultAppNameFromStep2",
"Sites": [
{
"Url": "https://YOURDOMAIN.sharepoint.com/sites/YOURSITE",
"Permission": "Write",
"Action": "Grant"
}
]
}
Field Source Description
PnPAppClientId Step 5 Application (Client) ID of the PnP Management App
PnPAppTenantId Step 5 Directory (Tenant) ID of the PnP Management App
VaultAppClientId Step 2 Application (Client) ID of the Vault Sites App
VaultAppName Step 2 Display name of the Vault Sites App (optional, for readability)
Sites[].Url Step 1 Full URL to your SharePoint site – must match the exact path shown in SharePoint
Sites[].Permission N/A Permission level – use “Write” for Vault Share
Sites[].Action N/A Use “Grant” to enable access or “Revoke” to remove access
  1. Save the config.json file

  2. Windows: Launch PowerShell 7 with administrative privileges:

    • Right-click PowerShell 7 → Run as Administrator
  3. Mac: In the same terminal window from step 3, run this command and follow the prompts.

./vault-site-wizard.sh --config ./config.json
  1. Navigate to the directory containing the .ps1 script:

    • Copying the path from windows explorer and then pasting it into PowerShell after ‘cd‘:
      • cd C:\path\to\your\script\directory
  2. Run the configuration script (copy and paste the below code into Powershell7):

    • pwsh -NoProfile -ExecutionPolicy Bypass -File vault-site-wizard.ps1 -ConfigPath ./config.json

PowerShell window running vault-site-wizard.ps1 with the config.json path

  1. When prompted, sign in as a SharePoint site administrator or owner for each site

  2. Wait for the script to complete – you’ll see confirmation messages for each site

PowerShell output confirming Write access was granted to XQ Vault Share for the SharePoint site

Note: To revoke permissions later, edit your config.json file and change “Action”: “Grant” to “Action”: “Revoke”, then run the script again.

The final step is to connect your XQ Portal to the Azure and SharePoint configuration you just created.

  1. Log into your XQ Portal as a SuperUser
  2. Navigate to the Security page
  3. Scroll to the Vault Sharing & Offloading section
    • Click Enable

XQ Portal navigation menu

  1. Fill in the required information:
    • Certificate file: Upload the .pem file you generated in Step 3
    • SharePoint site URL: Your SharePoint site URL (e.g., https://hello.sharepoint.com/sites/Example)
    • Tenant ID: The Directory (Tenant) ID from your Vault App (Step 2)
    • Client ID: The Application (Client) ID from your Vault App (Step 2)

Vault Sharing Offloading section with Enable

  1. Click Save or Enable to complete the configuration

  2. You should see a success message confirming Vault Share is now enabled

XQ Management Portal Security settings showing a saved Vault Sharing & Offloading configuration

To verify your setup is working correctly:

  1. Open the XQ Vault application on your computer and login
  2. Go to the ‘Sharing’ tab in Vault
  3. Try sharing a new file (send to yourself)
  4. Confirm that when you receive the email with a download link to the file you can in fact download the file.

If you encounter issues during setup:

Certificate upload fails:

  • Verify you’re uploading the .cer file to Azure (not the .pem file)
  • Check that your certificate uses a supported algorithm (RSA-2048, RSA-3072, or RSA-4096)
  • Ensure the certificate hasn’t expired

Permission script fails:

  • Confirm you’re running PowerShell 7 with administrative privileges
  • Verify the PnP Management App has Sites.FullControl.All delegated permissions
  • Check that you’re signing in as a SharePoint site administrator or owner

Vault Share won’t enable in XQ Portal:

  • Verify you’re uploading the .pem file (containing both certificate and private key)
  • Double-check that your Tenant ID and Client ID are correct
  • Ensure the SharePoint domain and site name match your actual site URL

I don’t see ‘Sharing’ in the Vault Application:

  • Go to the Vault Download page and make sure you have the latest version of Vault.

Can’t find the answer you’re looking for? Our support team is here to help!

Contact Support: email support@xqmsg.com, or click Contact Support in the XQ Dashboard.

Now that Vault Share is configured, you can:

Your Vault Share integration is now complete and ready to use!