Operation: Add Certificate / Update Certificate
Description: To Add/Update Certificates. 

Sample Configuration
<Certificate> <Action>UploadCertificate/GenerateSelfSignedCertificate/GenerateCertificateSigningRequest/RequestLetsEncryptCertificate</Action> <Name>Name</Name> <!-- for UploadCertificate --> <CertificateFormat>Text</CertificateFormat> <CertificateFile>{Filename uploaded in multipart request}</CertificateFile> <PrivateKeyFile>{Filename uploaded in multipart request}</PrivateKeyFile> <Password>Password</Password> <!-- For GenerateCertificate and GenerateCSR --> <ValidFrom>2011-03-06</ValidFrom> <ValidUpto>2011-03-06</ValidUpto> <KeyType>RSA/Elliptic Curve</KeyType> <!-- When KeyType is RSA --> <KeyLength>1024/1536/2048/4096</KeyLength> <!-- When KeyType is Elliptic Curve --> <CurveName>secp256r1/secp384r1</CurveName> <SecureHash>SHA - 256/SHA - 384/SHA - 512</SecureHash> <CountryName>Andorra</CountryName> <StateProvinceName>name</StateProvinceName> <LocalityName>CityName</LocalityName> <OrganizationName>CompanyName</OrganizationName> <OrganizationUnitName>DepartmentName</OrganizationUnitName> <CommonName>ServersHostname</CommonName> <EmailAddress>email</EmailAddress> <DNSSubjectAltNames> <DNSName>Domain name</DNSName> </DNSSubjectAltNames> <IPAddressSubjectAltNames> <IPAddress>IP Address</IPAddress> <IPAddress>IPv6 Address</IPAddress> </IPAddressSubjectAltNames> <CertificateIDType>DNS/IP Address/Email/DER ASN1 DN (X.509)</CertificateIDType> <CertificateID>ipaddress</CertificateID> <!-- For Lets Encrypt certificate --> <HostedAddress>123.123.123.123</HostedAddress> </Certificate>



Parameter Mandatory Default Description
ActionNo  
Select an option: Upload Certificate, Generate Self Signed Certificate,
Generate Certificate Signing Request (CSR), or Request a Let's Encrypt? certificate.
Action confines to:
  • Type is 'SCALAR'.
  • Only 'UploadCertificate', 'GenerateSelfSignedCertificate', 'p', 'GenerateCertificateSigningRequest', 'UploadRemoteCertificate', 'RequestLetsEncryptCertificate', 'e' are allowed.
NameYes  
Specify name of the Certificate.
Name confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Allowed characters: (A-Za-z0-9_@\-\.)
  • Maximum characters allowed are 50.
  • UTF-8 character(s) are allowed.
CertificateFileNo  
Browse and select the certificate file to be uploaded.
CertificateFile confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • File formats 'PEM', 'der', 'cer', 'p7b', 'pfx', 'p12' are allowed.
PrivateKeyFileNo  
Browse and select the private key file to be uploaded.
PrivateKeyFile confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • File formats 'key' are allowed.
PasswordNo  
Specify a password for the Certificate used for authentication.
Password confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 128.
  • Minimum characters allowed are 4.
ValidFromNo  
Specify date from which the Certificate is valid.
ValidFrom confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
ValidUptoNo  
Specify date upto which the Certificate is valid.
ValidUpto confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
KeyTypeNo RSA 
For key type, select RSA or elliptic curve.
KeyType confines to:
  • Type is 'SCALAR'.
  • Only 'RSA', 'Elliptic Curve' are allowed.
KeyLengthNo 2048 
Select key length, or the number of bits used to construct the key.
KeyLength confines to:
  • Type is 'SCALAR'.
  • Only '1024', '1536', '2048', '4096' are allowed.
CurveNameNo secp256r1 
Select curve name.
CurveName confines to:
  • Type is 'SCALAR'.
  • Only 'secp256r1', 'secp384r1', 'secp521r1' are allowed.
SecureHashNo SHA - 256 
Select secure hash.
SecureHash confines to:
  • Type is 'SCALAR'.
  • Only 'SHA - 256', 'SHA - 384', 'SHA - 512' are allowed.
KeyEncryptionNo Disable 
Click to enable Key encryption.
KeyEncryption confines to:
  • Type is 'SCALAR'.
  • Only 'y', 'n', 'N', 'Y' are allowed.
CertificateIDTypeNo  
Select the Certificate ID from the options.
CertificateIDType confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
CertificateIDNo  
Specify the value corresponding to the Certificate ID selected.
CertificateID confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
CountryNameNo  
Select the Country from the available options.
CountryName confines to:
  • Type is 'SCALAR'.
  • Only 'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BA', 'BW', 'BV', 'BR', 'IO', 'VG', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CG', 'CD', 'CK', 'CR', 'HR', 'CU', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'TL', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HM', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'CI', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'FX', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'KP', 'MP', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'KR', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'VI', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU', 'VA', 'VE', 'VN', 'WF', 'EH', 'YE', 'ZM', 'ZW', 'YD', 'SU', 'PU', 'BQ', 'CT', 'DD', 'FQ', 'JT', 'MI', 'NQ', 'NT', 'PC', 'PZ', 'QO', 'QU', 'VD', 'WK', 'ZZ' are allowed.
OrganizationNameNo  
Specify the organization name which will use this Certificate and domain name.
OrganizationName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 64.
Note:
Domain name must be unique.
OrganizationUnitNameNo  
Specify the department name which will use this Certificate and domain name.
OrganizationUnitName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 64.
Note:
Domain name must be unique.
StateProvinceNameNo  
Specify the state within the country.
StateProvinceName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 128.
LocalityNameNo  
Specify the name of the locality.
LocalityName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 128.
CommonNameYes  
Specify Common name which compromises of host and domain name.
CommonName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 64.
EmailAddressNo  
Specify the Email Address of the person to contact for communication.
EmailAddress confines to:
  • Type is 'SCALAR'.
  • Datatype is 'EMAIL'.
  • Maximum characters allowed are 128.
HostedAddressNo  
Interface on which the Let's Encrypt? challenge for domain name ownership is served.
HostedAddress confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS','IPADDRESS6'.
  • IP Class other than 'MULTICAST', 'RESERVED', 'LOCALHOST', 'UNSPECIFIED', 'BROADCAST', 'LINKLOCAL' is allowed.
KeyEncryptionNo  
Click to enable Key encryption.
KeyEncryption confines to:
  • Type is 'SCALAR'.
  • Only 'y', 'Y', 'n', 'N' are allowed.
CertificateFormatNo  
Select format of Certificate file from the available options.
CertificateFormat confines to:
  • Type is 'SCALAR'.
  • Only 'pem', 'der', 'cer', 'pkcs7', 'pkcs12', 'p7b' are allowed.
DNSNameNo  
List of DNS Subject Alternative Names (SANs).
DNSName confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
DNSNameNo  
Specify a DNS Subject Alternative Name (SAN).
DNSName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
IPAddressNo  
List of IP address Subject Alternative Names (SANs).
IPAddress confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
IPAddressNo  
Specify an IP address Subject Alternative Name (SAN).
IPAddress confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
certnameNo  
Specify 'certname'
confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.



Operation   Status   Message
Add Certificate200
Add Certificate500
Add Certificate502
Add Certificate503
Add Certificate510
Add Certificate519
Add Certificate541
Update Certificate200
Update Certificate500
Update Certificate503
Update Certificate519
Update Certificate510
Update Certificate541

© Copyright Sophos Firewall Limited. All rights reserved.
Sophos Firewall is registered trademarks of Sophos Firewall Limited and Sophos Firewall Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.