Посібник із встановлення програмного забезпечення Changepoint API

Інструкція зі встановлення API
Довідковий посібник
Точка змін 2021

© 2021 Changepoint Canada ULC. Усі права захищено. ПРАВА УРЯДУ США. Використання, копіювання або розголошення урядом США підлягає обмеженням, викладеним у ліцензійній угоді Changepoint Canada ULC та згідно з DFARS 227.7202-1(a) та 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (жовтень 1988), FAR 12.212(a) (1995), FAR 52.227-19 або FAR 52.227-14 (ALT III), залежно від обставин. Цей продукт містить конфіденційну інформацію та комерційні секрети Changepoint Canada ULC. Розголошення заборонено без попереднього письмового дозволу Changepoint Canada ULC. Використання цього продукту регулюється умовами Ліцензійної угоди користувача з Changepoint Canada ULC. Документація може бути відтворена Ліцензіатом лише для внутрішнього використання. Зміст цього документа не може бути змінено, модифіковано або змінено без прямої письмової згоди Changepoint Canada ULC. Changepoint Canada ULC може будь-коли змінювати вміст, зазначений тут, з повідомленням або без нього.

Встановлення Changepoint API

Про встановлення Changepoint API
Changepoint API доступний як COM API, служба Windows Communication Foundation (WCF) і, для зворотної сумісності, як Web Служба покращення послуг (WSE). Щоб отримати інформацію про Changepoint API, перегляньте Довідник Changepoint API. Примітки щодо оновлення, застереження та відомі проблеми див. у Примітках до випуску в папках команди в Changepoint.
Оновлення Changepoint API
Якщо ви оновлюєте попередній випуск Changepoint, скористайтеся панеллю керування Windows, щоб видалити попередню версію API Changepoint та його компоненти перед встановленням цієї версії.
Вимоги до Changepoint API
Перш ніж інсталювати Changepoint API, потрібно встановити Changepoint. Вимоги до програмного забезпечення див. у Матриці сумісності програмного забезпечення Changepoint, яка доступна в папці команди «Примітки до випуску та виправлення» 2021 у Changepoint.
File умовні позначення шляху
У цьому документі для загальних шляхів використовуються такі умовні позначення:

• Кореневий шлях інсталяції Changepoint.
  Шлях за замовчуванням:
  C: Програма Files (x86)Точка зміниТочка зміни
• Кореневе розташування для поширених утиліт Changepoint, таких як утиліта Login Settings.
  Шлях за замовчуванням:
  C: Програма Files (x86) Загальні FilesChangepointChangepoint

Встановлення Changepoint API

1. У кореневому каталозі носіїв Changepoint API запустіть setup.exe.
2. Дотримуйтесь підказок, доки не з’явиться екран вибору функцій.
3. Виберіть функції, які ви хочете інсталювати, а потім натисніть «Далі».
4. Виберіть папку призначення API за замовчуванням API та натисніть Далі.
   Примітка: Утиліта Changepoint Login Settings встановлена LoginSettings, незалежно від папки призначення, яку ви вкажете.
5. Якщо ви вибрали Web API служб: a. Коли виберіть Select
   a Web З’явиться екран сайту, виберіть a webсайту, до якого потрібно додати віртуальний каталог, а потім натисніть кнопку Далі.
   b. Натисніть «Далі», щоб продовжити. 6. Після завершення інсталяції API натисніть «Готово».

Налаштування Changepoint API для роботи з кеш-пам’яттю
Щоб налаштувати API Changepoint на роботу з кеш-пам’яттю, замініть значення для «cache. Пароль» і «Кеш. Сервери» в КП Web ПослугиWeb.config file зі значеннями, що використовуються на підприємствіWeb.config file.
Включення Web Покращення послуг (WSE)

1. Редагувати Web.config file для web послуги. Розташування за умовчанням:
   APICP Web ПослугиWeb.config
2. Знайдіть три екземпляри наступного рядка коментаря:
   < !– Розкоментуйте наступний елемент, якщо ви використовуєте Web API вдосконалення служби (WSE). Залишайте коментарі, якщо використовуєте служби WCF і не встановлюєте Web Service Enhancements (WSE) –>
3. Розкоментуйте елемент, який слідує за кожним екземпляром рядка коментаря:
   <section name=”microsoft.web.services2″ … >webПослуги>web.services2>
   Примітка: ThewebServices> елемент, який потрібно розкоментувати, є дочірнімweb>.

Налаштування журналювання для Web API служб
Ви повинні встановити журнал file рівні шляху та журналу. Рівні журналу накопичуються. наприкладample, якщо ви вкажете рівень 3, то рівні 1, 2 і 3 реєструються. Стандартний рівень журналу – 8.

1. Редагувати web послуги Web.config. Розташування за умовчанням:
   APICP Web ПослугиWeb.config
2. Встановіть журналFileшлях. Значення за замовчуванням: APIAPILogs. 3. Встановіть LogLevel. Допустимі значення:
   0 = без реєстрації
   1 = Вихідний об’єкт і метод
   2 = повідомлення про помилку
   3 = Вхідні параметри
   4 = Повернення
   5 = Попередження
   8 = контрольна точка

Налаштування автентифікації віртуального каталогу для Web API служб
Необхідно ввімкнути анонімний доступ і вимкнути інтегровану автентифікацію Windows для CPWebВіртуальний каталог служби в інформаційних службах Інтернету (IIS). Щоб отримати додаткові відомості, перегляньте документацію Microsoft IIS.
Налаштування параметрів підключення до бази даних для Web API служб
Використовуйте утиліту «Параметри входу», щоб зашифрувати параметри підключення до бази даних у Web API служб Web.config file. Для отримання додаткової інформації знайдіть «Налаштування параметрів з’єднання з базою даних» у Посібнику зі встановлення Changepoint.
Налаштування автентифікації для Changepoint WCF Web Послуги
Ви можете налаштувати автентифікацію програми та єдиний вхід (SSO) для Changepoint WCF Web Послуги.
За допомогою Secure Token Service (STS) доступні такі варіанти впровадження:

• SSO з використанням ISAPI SSL необов’язково
• SSO з використанням WS-Federation (ADFS 2.0) Потрібен SSL

Якщо SSL потрібен, сценарій налаштування гарантує його використання.
Конфігураційні сценарії для ISAPI та автентифікації програми можуть додатково ввімкнути SSL.
Налаштування автентифікації програми для WCF Web Послуги
Стандартний тип автентифікації для Changepoint WCF Web Послуги - це аутентифікація програми.
Використовуйте процедури в цьому розділі, щоб:

• налаштувати точку зміни WCF Web Служби для використання автентифікації програми за допомогою SSL
• повернути точку зміни WCF Web Сервіси аутентифікації додатків після впровадження однієї з реалізацій SSO

Налаштуйте PowerShell

1. Відкрийте підказку Windows PowerShell.
2. Змініть політику виконання:
   Set-ExecutionPolicy Unrestricted

Stage 1 Зберіть параметри конфігурації
Визначте значення для параметрів конфігурації.

Параметр	опис
WebService_Path	Розташування точки зміни WCF Web Послуги web додаток files. за замовчуванням: \API\CP Web Послуги
ServiceCertificate_ Ім'я	Ім’я сертифіката, яке використовуватиметься для автентифікації служби для клієнтів у режимі безпеки повідомлень. За замовчуванням: ім’я сертифіката «CN=ChangepointAPICertificate».
потрібен HTTPS	Вимагати HTTPS (Правда/Невірно) За замовчуванням: False.

Stage 2 Виконайте сценарії конфігурації
Використовуйте значення для параметрів конфігурації, щоб змінити конфігурацію webсайти.

1.  Відкрийте підказку PowerShell.
   Примітка: Якщо на вашому сервері ввімкнено контроль облікових записів користувачів, ви повинні відкрити запит PowerShell, використовуючи підвищені права адміністратора.
2. Перейдіть до КП web каталог конфігурації служби, за замовчуванням:
   КонфігураціяCPWebСервіс
3.  Виконайте ./Configuration_AppAuth.ps1
4. Дотримуйтесь підказок.

Налаштування єдиного входу (SSO) для WCF Web Послуги
Налаштуйте PowerShell

1. Відкрийте підказку Windows PowerShell.
2. Змініть політику виконання:
   Set-ExecutionPolicy Unrestricted

Налаштування SSO за допомогою ISAPI для WCF Web Послуги
Stage 1 Зберіть параметри конфігурації
Визначте значення наступних параметрів конфігурації.

Параметр	опис
WebService_Path	Розташування точки зміни WCF Web Послуги web додаток files. за замовчуванням: \API\CP Web Послуги
потрібен HTTPS	Вимагати HTTPS (Правда/Неправда). За замовчуванням: False.
Changepoint_RSA_ Cookie_Transform	Назва сертифіката, який ви використовуєте для шифрування файлів cookie. За замовчуванням: ім’я сертифіката «CN=ChangepointAPICertificate».
ServiceCertificate_Name	Введіть назву сертифіката, який використовуватиметься для автентифікації служби для клієнтів у режимі безпеки повідомлень. За замовчуванням: ім’я сертифіката «CN=ChangepointAPICertificate».
SigningCertificate_Name	Введіть назву сертифіката підпису. Це назва сертифіката, який ви використовуєте для підпису повідомлень. За замовчуванням: ім’я сертифіката «CN=ChangepointAPICertificate».
ISAPI_Mode	Режим ISAPI. За замовчуванням: NT
ISAPI_Header	Заголовок, який використовується, коли ISAPI_Mode має значення «HEADER», наприкладample, порожній.
ClaimType	Введіть тип вимоги SSO. За замовчуванням: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Виконайте сценарії конфігурації

1. Відкрийте підказку PowerShell.
   Примітка: Якщо на вашому сервері ввімкнено контроль облікових записів користувачів, ви повинні відкрити запит PowerShell, використовуючи підвищені права адміністратора.
2. Перейдіть до КП web каталог конфігурації служби, за замовчуванням:
   КонфігураціяCPWebСервіс
3. Виконайте: ./Configuration_SSO_ISAPI.ps1
4. Дотримуйтесь підказок.

Налаштування SSO за допомогою WS-Federation (ADFS 2.0) для WCF Web Послуги
Stage 1 Зберіть параметри конфігурації
Визначте значення для параметрів конфігурації в таблиці нижче. Переконайтеся, що ADFS_Server_URI знаходиться в зоні інтрамережі браузера кінцевого користувача.
Примітка: За замовчуванням Changepoint налаштовано на автоматичне оновлення відкритих ключів, які використовуються для підпису маркерів безпеки, за допомогою опублікованого документа метаданих федерації. В ADFS це:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
У деяких випадках може бути неможливо отримати доступ до сервера ADFS із точки зміни web тому вам доведеться вручну оновити конфігурацію після запуску сценарію конфігурації. Докладніше див. у розділі «Оновлення відкритих ключів вручну» на сторінці 12.

Параметр	опис
WebService_Path	Розташування точки зміни WCF Web Послуги web додаток fileс. За замовчуванням: \API\CP Web Послуги
WebService_URI	Ідентифікатор домену, який ви використовуєте для Changepoint WCF Web Послуги. наприкладampле., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform	Назва сертифіката, який ви використовуєте для шифрування файлів cookie. За замовчуванням: ім’я сертифіката «CN=ChangepointApiCertificate».
ServiceCertificate_Name	Ім’я сертифіката, яке використовуватиметься для автентифікації служби для клієнтів у режимі безпеки повідомлень. За замовчуванням: ім’я сертифіката «CN=ChangepointApiCertificate».
SigningCertificate_Name	Назва сертифіката, який ви використовуєте для підпису повідомлень. За замовчуванням: використовується назва сертифіката «CN=ChangepointApiCertificate».
ADFS_ FederationServiceName	Назва служби федерації. Щоб отримати ім’я: на сервері ADFS запустіть консоль керування ADFS 2.0. • Виберіть ADFS 2.0 у меню ліворуч. • На панелі «Дії» виберіть «Редагувати властивості служби федерації». Назва служби федерації знаходиться на вкладці Загальні.
ClaimType	Тип претензії SSO. За замовчуванням: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Виконайте сценарії конфігурації
Налаштуйте webсайти, використовуючи значення для параметрів конфігурації.

1. Відкрийте підказку PowerShell.
   Примітка: Якщо на вашому сервері ввімкнено контроль облікових записів користувачів, ви повинні відкрити запит PowerShell, використовуючи підвищені права адміністратора.
2. Перейдіть до точки зміни web каталог конфігурації служби, за замовчуванням: КонфігураціяCPWebСервіс
3.  Виконати: ./Configuration_SSO_ADFS.ps1
4. Дотримуйтесь підказок.

Stage 3 Створення довіри довіреної сторони
Створіть довіру перевіряючої сторони в консолі ADFS 2.0.

1. На сервері ADFS запустіть консоль ADFS 2.0.
2. Виберіть «Дія» > «Додати довіру перевіряючої сторони».
3. Натисніть кнопку Пуск.
4. Виберіть «Імпортувати дані про перевіряючу сторону», опубліковані в Інтернеті або в локальній мережі.
5. Введіть адресу метаданих федерації, а потім натисніть Далі, наприкладampле:
   https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
6. Введіть відображуване ім’я, наприклад Changepoint WCF API, і натисніть «Далі», «Далі», «Далі», а потім «Закрити».
7. Додайте правило претензії для вищезазначеної перевіряючої сторони точки зміни. Для Changepoint ім’я правила вимоги за замовчуванням – «UPN».
8. Зіставте атрибут LDAP «User-Principal-Name» із типом вихідної претензії «* UPN» або «UPN».

Ручне оновлення відкритих ключів
Щоб отримати відбиток підпису маркера сервера ADFS

1. На сервері ADFS запустіть консоль керування ADFS 2.0.
2. Виберіть Сервіс > Сертифікати та двічі клацніть сертифікат підпису маркера.
3. Виберіть вкладку Деталі.
4. Виберіть поле Відбиток.
5. Щоб отримати значення відбитка, видаліть усі пробіли, включаючи перший пробіл.

Щоб оновити Web.config file

1. Відредагуйте ADFS web.config. Розташування за умовчанням:
   EnterpriseRP-STS_ADFS
2. Під знайдіть ключ ida:FederationMetadataLocation і очистіть його значення:
   
3. Під , знайди і замініть його наступним: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />

Тестування підключення COM API

1. Запустіть набір тестів API. Розташування за умовчанням:
   APIAPI ComponentsApiTestKit.exe.
2. Натисніть Рядок підключення > Шифрувальник.
3. У полі Рядок з’єднань звичайного тексту:
   a. Замініть SERVERNAME і DATABASENAME інформацією вашої бази даних.
   b. Замініть USERID і PASSWORD інформацією про обліковий запис адміністратора бази даних.
   в. За потреби введіть значення часу очікування.
4. Натисніть Зашифрувати.
5. У полі «Рядок зашифрованого з’єднання» скопіюйте текст.
6. Закрийте діалогове вікно.
7. У меню API Test Kit клацніть Connection > COM API Connection Tester.
8. На вкладці «Поточна версія» вставте зашифрований рядок підключення в поле «Рядок підключення».
9. У полях LoginId і Password введіть ідентифікатор користувача та пароль для свого облікового запису Changepoint.
10. У полі Loglevel (0-8) вкажіть рівень інформації про помилку, яка буде повертатися в журналі COM API file якщо результат тесту показує проблему з підключенням.
    0 = без реєстрації
    1 = Вихідний об’єкт і метод
    2 = повідомлення про помилку
    3 = Вхідні параметри
    4 = Повернення
    5 = Попередження
    8 = контрольна точка
    За замовчуванням 8.
11. Натисніть Connect.
    Якщо підключення відбулося успішно, у полі результату з’явиться повідомлення про успішне підключення. Якщо підключення не вдалося, перевірте журнал COM API file за помилки. Стандартне розташування журналу file є APIAPILogs.

Перевірка версії встановлених компонентів API
Ви можете використовувати утиліту перевірки версій, щоб отримати докладні відомості про встановлені компоненти, включаючи версію випуску та шлях.

1. Запустіть CPVersionChecker.exe. Шлях за замовчуванням: Компоненти APIAPI
2. Натисніть Прочитати.

Перевірка версії Web API служб

1. Запустіть Internet Explorer із сервера, де знаходиться Web Services API встановлено, і введіть адресу:
   http://localhost.port/CPWeb.Service/WSLogin.asmx  де порт — це номер порту webсайт, де ви встановили CPWebСлужба віртуального каталогу.
2. На сторінці WSLogin натисніть посилання GetVersion.
3. Натисніть Викликати.

Тестування Web Підключення API служб

1. Запустіть Internet Explorer із сервера, де знаходиться Web Services API встановлено, і введіть адресу: http://localhost.port/CPWeb.Service/WSLogin.asmx  де порт — це номер порту webсайт, де ви встановили CPWebСлужба віртуального каталогу.
2. На сторінці WSLogin натисніть посилання TestConnection.
3. Натисніть Викликати. 4. У результатах тестування:

• Якщо елемент false, тестове з'єднання вдалось.
• Якщо елемент істинний, тестове підключення не вдалося. Для більш
  інформацію про причини збою див і елементи в результатах тестування та перевірте журнали API. Стандартний шлях до журналів API: APIAPILogs

Налаштування Web API служб на мовному сервері

1. Щоб розгорнути Changepoint Web API служб на мовному сервері, потрібно додати або оновити tag в Web API служб web.config. Розташування за замовчуванням Web.config file це: APICP Web ПослугиWeb.config
2. Якщо tag вже існує, переконайтеся, що атрибути культури та uiCulture мають значення «en-US».
3. Якщо tag ще не існує, додайте наступне , коментар і елементів доweb> вузол:web>
   Параметри Visual Basic: установіть strict=”true”, щоб заборонити всі перетворення типів даних, у яких може статися втрата даних. Встановіть explicit=”true” для примусового оголошення всіх змінних. –>
4. Перезапустіть IIS.