Page Comparison

...

Property

Type

Function

Uri

String

This property contains the URI of the desired endpoint. Schema and host are mandatory, the specification of a port is optional. If no port is specified, the respective default ports (80 for HTTP and 443 for HTTPS) are used. If no IP address is specified as the host, the specified name is converted to an IP address using DNS lookup. The IP addresses 0.0.0.0 or * represent all available IP addresses of the server.

Certificate

JSON object

This property is only required when using HTTPS. The JSON object specified here requires the following properties:

Source
Specifies the location of the certificate. The following values are supported:

File
The certificate is available as a file.

UserStore
The certificate is located in the user-specific certificate store.

SystemStore
The certificate is located in the system-specific certificate store.

Store
The certificate is stored in a certificate store and Connect tries to determine it based on the other data.

Path
For Source "File" only: The path to the certificate file or the path to the directory containing the certificate file.

Name
Only for Source "File": If the "Path" property contains the directory that contains the certificate file, the file name of the certificate file must be specified here. Otherwise, this property can be omitted.

Password
Only for Source "File": The password for the private key contained in the certificate file.

FriendlyName (or DisplayName)
Selection criterion: The display name (friendly name) of the certificate to be used.

SerialNumber (or Serial or SerialNo)
Selection criterion: The serial number of the certificate to be used.

SubjectName (or Subject)

Selection criterion: The subject of the certificate to be used.

Thumbprint
Selection criterion: The fingerprint (thumbprint) of the certificate to be used.

The selection criteria are only evaluated if the certificate is to be read from a certificate store. Not all possible selection criteria have to be specified, but the certificate search must lead to a unique result. If several certificates meet the selection criteria, the web server cannot be started. Invalid certificates are not considered during certificate search.

The use of multiple certificates on the same endpoint is currently not supported. If an endpoint can be reached via different hostnames, these must be listed in a certificate. Wildcard certificates are supported without restrictions.

The ClientCertificates section (JSON Object)

The ServerCertificates section (JSON Object)

Use of certificates

Wherever certificates can be specified, a JSON object is expected. This object supports the following properties:

Property	Type	Function
Source	String	Specifies the location of the certificate. The following values are supported: File The certificate is available as a file. UserStore The certificate is located in the user-specific certificate store. SystemStore The certificate is located in the system-specific certificate store. Store The certificate is stored in a certificate store and Connect tries to determine it based on the other data. The user-specific certificate store is searched first. If this search does not produce any results, the search continues in the system-specific certificate store.
Path	String	For source "File" only: The path to the certificate file or the path to the directory containing the certificate file.
Name	String	For source "File" only: If the "Path" property contains the directory that contains the certificate file, the file name of the certificate file must be specified here. Otherwise, this property can be omitted.
Password	String	For source "File" only: The password for the private key contained in the certificate file.
FriedlyName oder DisplayName	String	Selection criterion for the certificate store: The display name (friendly name) of the certificate to be used.
SerialNumber oder SerialNo oder Serial	String	Selection criterion for the certificate store: The serial number of the certificate to be used.
IssuerName oder Issuer	String	Selection criterion for the certificate store: The issuer of the certificate to be used.
IssuerDistinguishedName	String	Selection criterion for the certificate store: The issuer of the certificate to be used as Distinguished Name (CN=...)
SubjectName oder Subject	String	Selection criterion for the certificate store: The subject of the certificate to be used.
SubjectDistinguishedName	String	Selection criterion for the certificate store: The subject of the certificate to be used as Distinguished Name (CN=...)
Thumbprint	String	Selection criterion for the certificate store: The fingerprint (thumbprint) of the certificate to be used.

The selection criteria are only evaluated if the certificate is to be read from a certificate store. Not all possible selection criteria need to be specified, but the certificate search must lead to a unique result. If several certificates fulfill all specified selection criteria and only one of them is valid, the valid certificate is used. If several valid certificates fulfill all specified selection criteria, the web server cannot be started.

Example

Code Block

language	json

...
  
  "Endpoints": [
    {
      "Uri": "http://*:80"
    },
    {
      "Uri": "https://*:443",
      "Certificate": {
        "Source": "File",
        "Path": "C:\Certificates",
        "Name": "Certificate.pfx",
        "Password": "CertificatePassword"
      }
    },
    {
      "Uri": "https://192.168.100.100:444",
      "Certificate": {
        "Source": "Store",
        "SerialNumber": "0123456789"
      }
    }
  ],
  
...

...

Version	Old Version 7	New Version 8
Changes made by	Thomas Erdösi	Thomas Erdösi
Saved on	May 05, 2022	May 13, 2022

Versions Compared

Key

The ClientCertificates section (JSON Object)

The ServerCertificates section (JSON Object)

Use of certificates

Example