Contents

Peer copy over HTTP or HTTPS

Summary

Nomad peer-to-peer content transfer uses SMB by default, which requires File and Print services to be enabled in order for it to share the content. For better security Nomad can be configured to use HTTP or HTTPS for peer-to-peer content transfer, removing the requirement for file shares. When Nomad is configured to use HTTP/S, if Peer Backup Assistant is enabled it will also use HTTP/S. 

Enabling HTTP/HTTPS

Enabling HTTP/S for peer-to peer content transfer (including Peer Backup Assistant) is done by modifying the relevant bits of the P2PEnabled registry value as follows.

P2PEnabled is a numeric value where, when represented in binary, each bit represents a configurable option, The table below only shows the bits that are relevant to P2P protocol selection. These values can be combined with other P2P settings - refer to P2PEnabled for full details. 

BitHexDecimalP2P Protocol used
00x011SMB
50x2032HTTP
60x4064HTTPS

It is important to ensure all clients are configured to use the same protocol, as a mismatch in protocol will prevent Nomad peers copying content from the elected master. You can enable multiple protocols on a client - for example P2PEnabled = 0x61 enables the peer to connect to the elected master using either HTTPS, HTTP or SMB. In this scenario, the peer will attempt the most secure protocol (HTTPS) first, followed by HTTP and finally falling back to SMB if it is unable to connect using HTTPS or HTTP.

HTTP and HTTPS Ports

When you enable HTTP and/or HTTPS, by default Nomad will use port 5080 for HTTP and 5443 for HTTPS, If these ports are already in use in your environment, you can define custom port numbers using the following registry values.

Registry valueDefault valueNotes
P2PHttpPort5080Default HTTP port to use for peer copy. If you are using a custom port, ensure that all Nomad clients use the same custom port.
P2PHttpsPort5443Default HTTPS port to use for peer copy. If you are using a custom port, ensure that all Nomad clients use the same custom port.

Authentication

Server Authentication

Server Authentication is required when Nomad is configured to use HTTPS for peer-to-peer content transfer. In this scenario, Nomad binds a server authentication certificate to the HTTPS endpoint to secure the communication between the elected master and peers. This certificate can be generated either by Nomad (self-signed) or through a Public Key Infrastructure (PKI). Use the P2PSslSettings to configure Nomad to use either self-signed (default) or PKI certificate.

Client Authentication

Client authentication is required when Nomad peers connect to the elected master. Nomad supports two client authentication methods - Windows Authentication and Certificate-based authentication.

Windows Authentication

By default, Nomad peers use the local SMSNomadP2P& account, which is created by Nomad on each client, to authenticate with the elected master (when the master is elected, it shares a key that enables them to determine the credentials for this local account on the master). This requires each client to allow their local SMSNomadP2P& account to access the computer from the network. Alternatively, Nomad peers can be configured to use their Computer Account to authenticate with the elected master using the SpecialNetShare setting. If the Computer Account is used, theDomain Computers group at a minimum must configured to access the computer from the network on all clients. 

By default, the elected Nomad master will allow connections from its own SMSNomadP2P& account and all Authenticated Users (Authenticated users is required when using the peer's Computer Account to authenticate). You can restrict this further to just the SMSNomadP2P& account using the AuthenticatedUsers setting.

Certificate-based Authentication

When Nomad is configured to use HTTPS for peer-to-peer content transfer, peers can use a PKI Client Authentication certificate to authenticate with the elected master. This is more secure than Windows Authentication as it does not require any local accounts to be granted 'Access this computer from the network' permissions. To enable certificate-based client authentication

  • Configure clients to use HTTPS for peer-to-peer content transfer through the P2PEnabled client setting.
  • Ensure clients have enrolled a Client Authentication certificate from a PKI in the Local Computer Personal certificate store. (Self-signed certificates cannot be used for Client Authentication). If you are using Configuration Manager with HTTPS site systems, you should already have a suitable PKI Client Authentication certificate enrolled on all CM clients that Nomad can use for P2P client authentication. 
  • Optionally (but recommended) configure CertIssuer client setting to assist Nomad in selecting the correct client authentication certificate if there are several in the Local Computer Personal certificate store 
  • Configure P2PSslSettings to enable certificate-based client authentication. When this option is enabled, Nomad does not create the local SMSNomadP2P& account.

If you enable certificate-based authentication for peer-to-peer content transfer, you must ensure that a valid client authentication certificate is available at all times. If the certificate expires, Nomad will return ERROR_CLIENT_CERT_MISSING (0X209A). This error code has been added to the Nomad SuccessCodes default setting, which means that Nomad will fail the download job and CM will not fall back to BITS to download the content from the DP. Nomad will not be able to download any content until a valid certificate becomes available on the client.

Certificate Selection

If you have configured Nomad to use a PKI certificate for server or client authentication, when Nomad starts it will look for an appropriate certificate in the Local Computer Personal certificate store. In most cases Nomad will be able to select an appropriate certificate without any additional configuration. In some cases you may need to specify CertIssuer and possibly CertSubject. 

Server Authentication certificate selection

Nomad will select a server authentication certificate in the Local Computer Personal certificate store using the following criteria 

  • Store = MY (the default certificate store)
  • Usage = Server Authentication
  • Subject/DNS = Host name or FQDN
  • Valid (NotBefore is in the past) and not expired (NotAfter is in the future)
  • Issuer = CertIssuer (Optional)

In most cases the built-in criteria is sufficient to determine a single applicable certificate. If multiple certificates are likely to match this criteria, you can optionally specify CertIssuer to limit the certificates that Nomad will consider to those issued by one or more specific Certificate Authorities. Note that CertIssuer also affects the selection of the Client Authentication certificate. If the server and client authentication certificates are issued by different Certificate Authorities, you can specify multiple CAs with CertIssuer, either using a sub-string that is common to the desired CA names, or a comma-separated list of CA names.

If multiple certificates match the criteria above, Nomad uses the following order of precedence when matching the Subject Name:

  • Hostname and FQDN
  • Hostname
  • FQDN

If a single certificate matching the criteria still cannot be resolved, the matching certificate with the longest validity is used.

  • When using Net literal names (3rd bit in P2PEnabled is set), clients ignore mismatch in host names during the SSL handshake – this is because IP addresses are generally not included in certificates
  • When using self-signed certificates for server authentication, clients do not validate the certificate issuer since it is issued by NomadBranch and it is not a valid CA

  • Due to the nature of how proxy servers can be implemented, some of which can be quite complex, you may need to consult your networking specialist to see if exceptions need to be added to enable Nomad’s peer-copy over HTTP or HTTPS.

Client Authentication certificate selection

Nomad will select a client authentication certificate for peer-to-peer authentication from the Local Computer Personal certificate store using the following criteria if:

  • The Configuration Manager (CM) client is installed and configured to use PKI certificates for client authentication with CM site systems, Nomad will select the same certificate that CM uses
  • CM is using self-signed certificates, the following criteria will be used: 
    • Usage = Client Authentication
    • Valid (NotBefore is in the past) and not expired (NotAfter is in the future)
    • Issuer = CertIssuer (Optional).

Nomad will select the first certificate that matches the above criteria. CertIssuer should only be required if the CM client is using a self-signed certificate for client authentication with CM site systems and there are certificates from multiple Certificate Authorities. When CertIssuer is defined Nomad will select the first certificate issued by that CA that matches the other criteria.

Nomad also requires a client authentication certificate for authenticating with CM HTTPS Site Systems. In most cases it will use the same certificate for authentication with peers and CM site systems, which will typically be the PKI-issued CM client authentication certificate.

If for any reason a different certificate should be used for authentication with CM site systems, you can additionally specify CertSubject.

Missing or Invalid Client Authentication Certificate

If Nomad is unable to select a valid client authentication certificate for any reason (e.g. no certificate present, certificate expired or certificate is not from specified issuer), Nomad returns ERROR_CLIENT_CERT_MISSING (0x209A) for the download job. This error code is included in the default SuccessCodes, so if it occurs, Configuration Manager will not revert to downloading using BITS, thereby protecting the network from potential congestion.

  • In Windows PE, Nomad fails the job immediately.
  • In the full OS, Nomad retries every 10 minutes until a valid client certificate is available in the Local Computer Personal certificate store or timeout (defined by P2PClientCertWaitPeriodMins, 24 hours by default) occurs.
    • If a client certificate becomes available before timeout occurs, a new election is initiated and Nomad tries downloading the content again.
    • If no certificate becomes available within the timeout period, Nomad will fail the job.
    • During the timeout period, if the Nomad service is reset, the download job is paused or the system goes to sleep, Nomad will continue to wait for the timeout period to expire. Any other interruption (e.g. Nomad service is stopped or the download job is cancelled or expires) will cause the download job to fail with the appropriate error condition.
    • While the download job is waiting for a valid client certificate, Nomad will not process any other download jobs.
On this page:

Firewall exceptions

Depending on your preferences (protocols, ports) during installation, the installer will add the exceptions to Windows firewall.

If for some reason these exceptions are removed post-installation, Nomad service will automatically re-add them. You'll just have to restart the service. Nomad service checks and fixes required firewall exceptions whenever it starts.

You can verify these in its Inbound Rules:

  1. For HTTPS (port 5443)
    Verifying inbound rules for port 5443
  2. For HTTP (port 5080) 
    Verifying inbound rules for port 5080

Note that the firewall exceptions are added against the program "system" not NomadBranch.exe. This is because Nomad uses Windows HTTP Server API to create the HTTP server and under this API all requests are handled by Windows kernel's "system" program not by Nomad directly. In some third-party firewalls you may have to use the program name "ntoskrnl.exe", since "system" is actually alias for ntoskrnl.exe.

Windows PE support

When running in Windows PE, Nomad can download content from peers over HTTP/S, but is not able to serve content to others (a Windows PE client will not be elected as a master). However Nomad still needs to be configured correctly (port usage and certificate type) or it will not be able to connect peers.

Certificate-based P2P Client Authentication in Windows PE

When Nomad is configured to use certificate-based client authentication for peer-to-peer content transfer, to support running in Windows PE you will need to update the Windows PE boot image(s) to include a client authentication certificate in the Windows PE boot image (as Windows PE will not be able to enrol a Client Authentication certificate, typically done through Active Directory). If you are using 1E PXE Everywhere and have prepared boot images using UpdateBootImage with a PKI-issued client authentication certificate, no further action is required. If you are not using PXE Everywhere, or have prepared boot images using a CM self-signed certificate you will need to update your boot images to use a PKI-issued Client Authentication certificate. 

If CM is using PKI-issued certificates for Client Authentication, you can use (export) the certificate that CM will have already prepared for use with boot images. If CM is using self-signed certificates, you will need to export a suitable PKI-issued Client Authentication certificate. In either case, you will need to export the appropriate certificate and provide the path to the exported certificate in the UpdateBootImage UI / command line. Even if you are not using PXE Everywhere, you can use the UpdateBootImage tool by installing just the PXE Everywhere Admin Tools on a device that has the CM console and Windows 10 ADK (version corresponding to the version of Windows PE you are using for your boot images). You can download PXE Everywhere from the 1E Support Portal.

To find out more about preparing boot images with UpdateBootImage, refer to PXE Everywhere 4.0 - Preparing and deploying the PXE Everywhere boot image. 

Certificate-based P2P Client Authentication in the full OS

When the Task Sequence is running in the full OS (For example, after rebooting following installation of the OS image), Nomad will attempt to locate a client authentication certificate using the Certificate Selection process detailed above. If it's unable to find a certificate in the store, Nomad uses the certificate that was added to the boot image and used during the Windows PE stage of the Task Sequence.

Configuring Nomad to to use HTTP/S in Windows PE

Nomad uses a custom Install and configure Nomad in WinPE Task Sequence step to install Nomad after the Task Sequence has booted into Windows PE. The settings highlighted below are related to configuration for HTTP/S.

  • P2PEnabled must be set to include HTTP or HTTPS. By default, this is set to 0x9, which disables HTTP/S
  • P2PHttpPort is disabled unless HTTP is enabled (bit 0x20 set in P2PEnabled). It defines the port that is used for Nomad P2P communication over HTTP (default 5080)
  • P2PHttpsPort is disabled unless HTTPS is enabled (bit 0x40 set in P2PEnabled). It defines the port that is used for Nomad P2P communication over HTTPS (default 5443)
  • Use PKI cert for client auth enables certificate-based client authentication, which requires a PKI-issued certificate. Selecting this option sets bit 0x2 of P2PSslSettings
  • Use PKI cert for server auth configures Nomad to use a PKI certificate for server authentication when HTTPS P2P is enabled (bit 0x40 set in P2PEnabled). If this option is not checked and bit 0x40 in P2PEnabled is set, Nomad will use a self-signed certificate for server authentication. 



Configuring use of PKI-issued certificates post-installation

If Nomad was originally installed to use HTTPS with self-signed certificates for server authentication and you want to switch to using PKI-issued certificates, do the following:

  1. Deploy the certificate to all Nomad clients. Ensure that the certificate's usage is Server Authentication and the certificate Subject is the client's host name or FQDN.
  2. Enable HTTPS (Bit 6 - 0x0040) in P2PEnabled.
  3. Update CertIssuer with the name of the certificate authority.
  4. P2PSslSettings set to 1 to enable PKI certificate for server authentication.
  5. Restart the Nomad service.

Checking the status of your Nomad P2P HTTP server

To check the status of the P2P HTTP server:

  1. Open the NomadBranch log. 
  2. When the Nomad service starts, it logs a list of URLs it listens to,
    Checking the status of your P2P HTTP server 
  3. Alternatively, run NETSH to check the status of the P2P HTTP server:
    Checking the status of the HTTP server using NETSH 

Checking SSL certificate bindings

To check the bindings of your SSL certificates:

  1. Open the Nomad log.
  2. When the Nomad service starts, it logs the name of the certificate and its issuer.
    Checking the status of your certificate bindings
  3. Alternatively, run NETSH to check the bindings for the certificates. In our example, the bindings for port 5443 are:
    Checking certificate bindings with NETSH

Troubleshooting failures during HTTP/HTTPS downloads

The most likely causes of HTTP/HTTPS download failures occur during a connection to a master. The most common errors are detailed below:

Error codesReason
0x00002efd
0x00004CF

HTTP/HTTPS is not enabled on the master or HTTP/HTTPS server on the master is listening on different port.

In our example, the log illustrates that HTTPS had not been enabled on the PC1 master.
Protocol not enabled on the master

Possible solution: Double-check the values of P2PEnabled on both the client and remote peer - they should be the same.


0x00002f8f
0x000000A
Invalid Certificate on master.

In our example, issues with certificates causes the download to fail with 0x00002f8f (security error) and the logging does not identify the cause of the failure.
Unknown CA for the certificate
Where errors like this occurs, check the following on master:
  • Expiry date
  • Subjects – should contain hostname or its FQDN
  • Issuer must be trusted via the trust chain on the peer machine
  • SSL Binding – ensure it exists for the HTTPS port