WebServerOptions - класс

Настройки веб-сервера TESSA, используемого для Kestrel. Обычно содержатся в файле app.json и доступны по свойству Configuration. Конструктор по умолчанию создаёт объект, в котором все свойства имеют рекомендованные значения по умолчанию.

Definition

Пространство имён: Tessa.Web
Сборка: Tessa.Web (в Tessa.Web.dll) Версия: 4.0.4
C#
public sealed class WebServerOptions
Inheritance
Object    WebServerOptions

Конструкторы

WebServerOptionsИнициализирует новый экземпляр класса WebServerOptions

Свойства

CertificateFile Путь к файлу сертификата для соединения по HTTPS или null (по умолчанию), если сертификат не загружается из файла. Загрузка сертификата из файла более приоритетна, чем его загрузка из хранилища.
CertificateKeyFile Путь к файлу приватного ключа сертификата CertificateFile или null (по умолчанию), если приватный ключ не требуется или сертификат не загружается из файла.
CertificatePassword Пароль для сертификата в файле CertificateFile или null (по умолчанию), если пароль не требуется или сертификат не загружается из файла. Загрузка сертификата из файла более приоритетна, чем его загрузка из хранилища.
CertificateStoreLocation Местоположение хранилища сертификатов, из которого загружается сертификат для соединения по HTTPS, или null (по умолчанию), если сертификат не загружается из хранилища. Загрузка сертификата из хранилища менее приоритетна, чем его загрузка из файла.
CertificateStoreName Имя хранилища сертификатов, из которого загружается сертификат для соединения по HTTPS, или null (по умолчанию), если сертификат не загружается из хранилища. Загрузка сертификата из хранилища менее приоритетна, чем его загрузка из файла.
CertificateStoreSubject Поле "Subject" сертификата из хранилища, поиск которого выполняется. Укажите null (не рекомендуется), чтобы использовался первый доступный сертификат в хранилище. По умолчанию указана строка "localhost". Для загрузки из хранилища также должны быть установлены свойства CertificateStoreName и CertificateStoreLocation.
Configuration Объект настроек, загруженный из конфигурации app.json.
DataProtectionCertificateFile Путь к файлу сертификата для шифрования сохраняемых ключей "Data Protection", используемых сервером Kestrel, или null (по умолчанию), если ключи шифруются средствами текущей учётной записи (на Windows) или не шифруются (на Linux, не рекомендуется). Настройка игнорируется, если не указан путь DataProtectionKeysPath.
DataProtectionCertificateKeyFile Путь к файлу приватного ключа сертификата DataProtectionCertificateFile для шифрования сохраняемых ключей "Data Protection", используемых сервером Kestrel, или null (по умолчанию), если приватный ключ не требуется или сертификат не загружается из файла. Настройка игнорируется, если не указан путь DataProtectionKeysPath.
DataProtectionCertificatePassword Пароль для файла сертификата DataProtectionCertificateFile для шифрования сохраняемых ключей "Data Protection", используемых сервером Kestrel, или null (по умолчанию), если пароль не требуется или сертификат не загружается из файла. Настройка игнорируется, если не указан путь DataProtectionKeysPath.
DataProtectionKeysPath Путь для сохранения ключей "Data Protection", используемых сервером Kestrel. Если указаны null или пустая строка, то по умолчанию используется папка внутри профиля %LocalAppData%. При запуске в контейнере Docker укажите путь к папке, которая включена в volume Docker, чтобы содержимое папки сохранялось между запусками приложения. В остальных случаях можно оставить путь пустым. Подробнее этот механизм описан в MSDN: https://docs.microsoft.com/en-us/aspnet/core/security/data-protection/configuration/overview?view=aspnetcore-3.1
EnforceTls12 Признак того, что сервер будет разрешать только подключения от клиентов по протоколам TLS 1.2 и TLS 1.3. Если указано false, то также разрешается подключение по TLS 1.0 и TLS 1.1. Если указать true, то могут возникнуть проблемы с подключениями клиентов со старыми версиями Windows или с установкой на сервер со старой версией Windows (Windows 7, Windows 8, Windows Server 2008R2 Windows Server 2012) - на этих версиях ОС поддержку TLS 1.2 можно включить установкой обновления Windows и модификацией реестра - обратитесь к MSDN. Установите true только в том случае, если вы уверены, что таких клиентов не будет, или если их не должно быть по политике безопасности вашей организации. По умолчанию false.
HstsMaxAgeDays Количество дней, передаваемых в заголовке HSTS, если указан режим HttpsRedirect, равный Hsts. На указанное количество дней браузер запоминает, что к указанному домену и его поддоменам следуем обращаться только по протоколу HTTPS, даже если пользователь указал HTTP. По умолчанию равно 365.
Http2Disabled Признак того, что на сервере отключается поддержка протокола HTTP/2, при этом будет использован только протокол HTTP 1.1. Укажите эту настройку, если при открытии веб-приложения в браузере возникает ошибка ERR_HTTP2_INADEQUATE_TRANSPORT_SECURITY. По умолчанию false.
HttpsRedirect Режим редиректа с протокола HTTP на endpoint с протоколом HTTPS. По умолчанию Disabled.
HttpsRedirectPort Порт, по которому выполняется редирект с протокола HTTP на endpoint с протоколом HTTPS, если такой редирект доступен согласно настройке HttpsRedirect. Укажите null (по умолчанию), чтобы автоматически выбрать порт в соответствии со списком прослушиваемых адресов (должен быть только один адрес, прослушиваемый по протоколу https, иначе редирект не будет выполняться).

Методы

EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
FromConfiguration(DictionaryString, Object) Создаёт объект настроек по заданному объекту с хеш-таблицей. По ключу "WebServer" в этой хеш-таблице должны быть настройки. Имена настроек соотносятся с именами свойств текущего объекта.
FromConfiguration(IConfigurationManager) Создаёт объект настроек по заданному объекту конфигурации. В нём по свойству configurationManager.Configuration.Settings доступна хеш-таблица, в которой есть ключ "WebServer", содержащий настройки. Имена настроек соотносятся с именами свойств текущего объекта.
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
SetFrom Устанавливает свойства класса в соответствии с переданным объектом.
ToString
(Переопределяет ObjectToString)

Методы расширения

Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)

См. также