ایجاد keystore و truststore برای نسخه 4.17.09 و نسخه‌های قدیمی‌تر «ابر خصوصی»

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

این سند نحوه ایجاد، اصلاح، و حذف کردن keystore و truststore برای Edge برای نسخه 4.17.09 و نسخه‌های قدیمی‌تر «ابر خصوصی» را شرح می‌دهد.

درباره انبار کلیدها و انبار اعتماد

«انبار کلید» و «انبار اعتماد» مخازن گواهینامه‌های امنیتی مورداستفاده برای رمزگذاری «امنیت لایه انتقال» را تعریف می‌کنند. تفاوت اصلی بین این دو این است که در فرایند دست دادن TLS در کجا استفاده می‌شوند:

  • محل ذخیره کلید حاوی گواهینامه TLS و کلید خصوصی است که برای شناسایی نهاد درحین دست‌دهی TLS استفاده می‌شود.

    در «امنیت لایه انتقال» یک‌طرفه، وقتی کارخواهی به نقطه پایانی «امنیت لایه انتقال» در سرور متصل می‌شود، انبار کلید سرور گواهینامه سرور (گواهینامه عمومی) را به کارخواه ارائه می‌کند. سپس کارخواه آن گواهینامه را با «مرجع صدور گواهینامه» (CA)، مثل Symantec یا VeriSign، معتبر می‌کند.

    در «امنیت لایه انتقال» دوطرفه، هم کارخواه و هم سرور محل ذخیره کلید را با گواهی و کلید خصوصی خود که برای اصالت‌سنجی متقابل استفاده می‌شود حفظ می‌کنند.
  • truststore حاوی گواهینامه‌هایی است که برای درستی‌سنجی گواهینامه‌های دریافتی به‌عنوان بخشی از دست دادن TLS استفاده می‌شود.

    در «امنیت لایه انتقال» یک‌طرفه، اگر گواهینامه توسط «مرکز صدور گواهینامه» معتبری امضا شده باشد، نیازی به truststore نیست. اگر گواهینامه دریافتی توسط کارخواه TLS با یک CA معتبر امضا شده باشد، کارخواه درخواستی به CA برای اصالت‌سنجی گواهینامه ارسال می‌کند. کارخواه «امنیت لایه انتقال» معمولاً از مخزن اعتماد برای اعتبارسنجی گواهینامه‌های خودامضایی دریافتی از سرور «امنیت لایه انتقال» یا گواهینامه‌هایی که توسط «مرجع گواهینامه» مورداعتماد امضا نشده‌اند استفاده می‌کند. در این سناریو، مشتری فروشگاه اعتماد خود را با گواهینامه‌هایی که به آن‌ها اعتماد دارد پر می‌کند. سپس، وقتی کارخواه گواهینامه سرور را دریافت می‌کند، گواهینامه ورودی دربرابر گواهینامه‌های موجود در truststore آن اعتبارسنجی می‌شود.

    برای مثال، کارخواه TLS به سرور TLS متصل می‌شود و سرور از گواهینامه خودامضایی استفاده می‌کند. ازآنجایی‌که گواهینامه خودامضا است، کارخواه نمی‌تواند آن را با «مرجع گواهینامه» اعتبارسنجی کند. درعوض، کارخواه گواهینامه خودامضای سرور را در فروشگاه اعتماد خود پیش‌بار می‌کند. سپس، وقتی کارخواه تلاش می‌کند به سرور متصل شود، کارخواه از مخزن اعتماد خود برای اعتبارسنجی گواهینامه دریافتی از سرور استفاده می‌کند.

    برای «امنیت لایه انتقال» دوطرفه، هم کارخواه «امنیت لایه انتقال» و هم سرور «امنیت لایه انتقال» می‌توانند از مخزن اعتماد استفاده کنند. وقتی Edge به‌عنوان سرور TLS عمل می‌کند، هنگام انجام TLS دوطرفه، مخزن مطمئن الزامی است.

گواهینامه‌ها می‌توانند توسط مرجع گواهینامه (CA) صادر شوند، یا می‌توانند توسط کلید خصوصی که تولید می‌کنید، خودامضا شوند. اگر به «مرجع صدور گواهی» دسترسی دارید، دستورالعمل‌های ارائه‌شده توسط «مرجع صدور گواهی» را برای تولید کلیدها و صدور گواهی‌ها دنبال کنید. اگر به «مرجع صدور گواهینامه» دسترسی ندارید، می‌توانید بااستفاده از یکی از ابزارهای رایگان دردسترس عموم، مثل openssl، گواهینامه خودامضاشده تولید کنید.

پیاده‌سازی انبار کلید و انبار اعتماد در Edge

در Edge، انبار کلید حاوی یک یا چند فایل JAR است، که فایل JAR حاوی موارد زیر است:

  • گواهینامه TLS به‌عنوان فایل PEM - یا گواهینامه‌ای که توسط مرجع گواهینامه (CA) امضا شده است، زنجیره گواهینامه‌ای که آخرین گواهینامه آن توسط مرجع گواهینامه امضا شده است، یا گواهینامه خودامضا.
  • کلید خصوصی به‌عنوان فایل PEM. ‫Edge از اندازه‌های کلید تا ۲۰۴۸ بیت پشتیبانی می‌کند. گذرعبارت اختیاری است.

«مخزن اعتماد» شبیه مخزن کلید است با این تفاوت که فقط گواهینامه‌ها را به‌صورت فایل PEM دربرمی‌گیرد، اما کلید خصوصی ندارد.

اگر گواهی بخشی از یک زنجیره است، انبار کلید/انبار اعتماد باید حاوی همه گواهی‌های موجود در زنجیره باشد، چه به‌صورت فایل‌های PEM جداگانه یا به‌صورت یک فایل واحد. اگر از یک فایل استفاده می‌کنید، گواهینامه‌ها باید به ترتیب باشند، به‌طوری‌که اولین گواهینامه در فایل گواهینامه‌ای باشد که برای TLS استفاده می‌شود و پس‌از آن زنجیره گواهینامه‌ها به ترتیب تا گواهینامه CA قرار گیرد. باید بین هر گواهینامه در فایل یک خط خالی درج کنید.

‫Edge میانای برنامه‌سازی کاربردی‌ای ارائه می‌دهد که از آن برای ایجاد مخزن کلید و مخزن اطمینان استفاده می‌کنید. میاناهای برنامه‌سازی کاربردی واقعی یکسان هستند. تفاوت این است که وقتی یک انبار کلید ایجاد می‌کنید، یک فایل JAR که حاوی گواهی و کلید خصوصی است را ارسال می‌کنید. وقتی یک فروشگاه مطمئن ایجاد می‌کنید، فقط گواهی را به‌عنوان یک فایل PEM ارسال می‌کنید.

درباره قالب فایل‌های گواهینامه و کلید

مثال‌های این سند گواهی و کلید «امنیت لایه انتقال» را به‌عنوان فایل‌های PEM تعریف می‌کنند که با قالب X.509 مطابقت دارند. اگر گواهی یا کلید خصوصی شما با فایل PEM تعریف نشده است، می‌توانید آن را بااستفاده از ابزارهایی مثل openssl به فایل PEM تبدیل کنید.

بااین‌حال، بسیاری از فایل‌های .crt و .key ازقبل در قالب PEM هستند. اگر این فایل‌ها فایل‌های نوشتاری باشند و در موارد زیر محصور شده باشند:

-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----

یا:

-----BEGIN ENCRYPTED PRIVATE KEY-----
-----END ENCRYPTED PRIVATE KEY-----

سپس فایل‌ها با قالب PEM سازگار می‌شوند و می‌توانید بدون تبدیل آن‌ها به فایل PEM، از آن‌ها در keystore یا truststore استفاده کنید.

اگر زنجیره گواهی دارید و می‌خواهید از آن زنجیره در keystore یا truststore استفاده کنید، می‌توانید همه گواهی‌ها را در یک فایل PEM با یک خط جدید بین هر گواهی ترکیب کنید. گواهینامه‌ها باید به‌ترتیب باشند و آخرین گواهینامه باید گواهینامه ریشه یا گواهینامه واسط امضاشده توسط گواهینامه ریشه باشد:

-----BEGIN CERTIFICATE-----
(Your Primary TLS certificate)
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
(Intermediate certificate)
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
(Root certificate or intermediate certificate signed by a root certificate)
-----END CERTIFICATE-----

دریافت جزئیات درباره انبار کلید موجود

بااستفاده از API فهرست کردن keystores و truststores، محیط خود را برای یافتن keystores موجود بررسی کنید:

curl -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores \
-u email:password

برای مشتریان فضای ابری، یک انبار کلید پیش‌فرض برای سازمان‌های دوره آزمایشی رایگان در هر دو محیط آزمایشی و تولید ارائه می‌شود. باید نتایج زیر را برای این تماس در هر دو محیط ببینید:

[ "freetrial" ]

می‌توانید از این انبار کلید پیش‌فرض برای آزمایش کردن میاناهای برنامه‌سازی کاربردی و انتقال میاناهای برنامه‌سازی کاربردی به تولید استفاده کنید، اما معمولاً قبل‌از استقرار در تولید، انبار کلید خودتان را با گواهینامه و کلید خودتان ایجاد می‌کنید.

برای مشتریان «ابر خصوصی»، آرایه برگشتی تا زمانی که اولین انبار کلید را ایجاد کنید خالی است.

محتوای keystore را بااستفاده از API دریافت Keystore یا Truststore بررسی کنید. برای مشتری ابری، باید گواهینامه TLS سرور تکی را ببینید--گواهینامه پیش‌فرضی که Apigee Edge برای حساب‌های آزمایشی رایگان ارائه می‌دهد.

curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/freetrial \
-u email:password

پاسخ باید به‌صورت زیر نشان داده شود:

{
 "certs" : [ "wildcard.apigee.net.crt" ],
 "keys" : [ "freetrial" ],
 "name" : "freetrial"
}

همچنین می‌توانید این اطلاعات را در «میانای کاربری مدیریت Edge» مشاهده کنید:

  1. در https://enterprise.apigee.com (ابر) یا http://<ms-ip>:9000 (در محل) به سیستم میانای کاربر مدیریت Edge وارد شوید، که در آن <ms-ip> نشانی IP گره «سرور مدیریت» است.
  2. در منو «واسط کاربر مدیریت Edge»، سرپرست > گواهینامه‌های TLS را انتخاب کنید.

دریافت جزئیات گواهینامه «امنیت لایه انتقال»

می‌توانید از API دریافت جزئیات گواهی از Keystore یا Truststore برای مشاهده جزئیات گواهی‌های «امنیت لایه انتقال» در keystore، مثل تاریخ انقضا و صادرکننده، استفاده کنید. ابتدا نام گواهینامه‌ای را که به آن علاقه دارید دریافت کنید. این مثال اطلاعات مربوط به انبار کلید با نام «freetrial» را واکشی می‌کند.

curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/freetrial \
-u email:password

پاسخ نمونه:

{
 "certs" : [ "wildcard.apigee.net.crt" ],
 "keys" : [ "freetrial" ],
 "name" : "freetrial"
}

سپس از مقدار دارایی certs برای دریافت جزئیات گواهینامه استفاده کنید:

curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/freetrial/certs/wildcard.apigee.net.crt \
-u email:password

پاسخ نمونه:

{
 "certInfo" : [ {
   "expiryDate" : "Wed, 23 Apr 2014 20:50:02 UTC",
   "isValid" : "Yes",
   "issuer" : "CN=Go Daddy Secure Certificate Authority - G2, OU=http://certs.godaddy.com/repository/, O=&quot;GoDaddy.com, Inc.&quot;, L=Scottsdale, ST=Arizona, C=US",
   "subject" : CN=*.example.apigee.net, OU=Domain Control Validated",
   "subjectAlternativeNames" : ["*.example.apigee.net","*.example.apigee.net" ],
   "validFrom" : "Tue, 15 Apr 2014 09:17:03 UTC",
   "version" : 3
 } ],
 "name" : "example.apigee.net.crt"
}

همچنین می‌توانید این اطلاعات را در «میانای کاربری مدیریت Edge» مشاهده کنید:

  1. در https://enterprise.apigee.com (ابر) یا http://<ms-ip>:9000 (در محل) به سیستم میانای کاربر مدیریت Edge وارد شوید، که در آن <ms-ip> نشانی IP گره «سرور مدیریت» است.
  2. در منو «واسط کاربر مدیریت Edge»، سرپرست > گواهینامه‌های TLS را انتخاب کنید.

در «واسط کاربر Edge»، می‌توانید مشخص کنید که Edge تا چه مدت قبل از انقضای گواهی، این موضوع را اعلام کند. به‌طور پیش‌فرض، رابط کاربری هر گواهینامه‌ای را که قرار است در ۱۰ روز آینده منقضی شود برجسته می‌کند.

ایجاد فروشگاه کلید

انبار کلید مختص به محیطی در سازمان شما است، برای مثال محیط آزمایش یا تولید. بنابراین، اگر می‌خواهید پیش‌از استقرار دادن انبار کلید در محیط تولید، آن را در محیط آزمایش آزمایش کنید، باید آن را در هر دو محیط ایجاد کنید.

ایجاد فروشگاه کلید فرایندی دو مرحله‌ای است:

  1. فایل JAR حاوی گواهی و کلید خصوصی‌تان ایجاد کنید.
  2. انبار کلید را ایجاد کنید و فایل JAR را بارگذاری کنید.

فایل JAR حاوی گواهی و کلید خصوصی‌تان ایجاد کنید

فایل JAR را با کلید خصوصی، گواهی، و مانیفست خود ایجاد کنید. فایل JAR باید شامل فایل‌ها و فهرست‌های راهنمای زیر باشد:

/META-INF/descriptor.properties
myCert.pem
myKey.pem

در دایرکتوری حاوی جفت کلید و گواهینامه‌تان، دایرکتوری‌ای به‌نام /META-INF ایجاد کنید. سپس فایلی به‌نام descriptor.properties در /META-INF با محتوای زیر ایجاد کنید:

certFile={myCertificate}.pem
keyFile={myKey}.pem

فایل JAR حاوی جفت کلید و گواهی‌تان را تولید کنید:

jar -cf myKeystore.jar myCert.pem myKey.pem

‫descriptor.properties را به فایل JAR اضافه کنید:

jar -uf myKeystore.jar META-INF/descriptor.properties

ایجاد فروشگاه کلید و بارگذاری فایل JAR

برای ایجاد یک انبار کلید در یک محیط، فقط باید نام انبار کلید را در ایجاد انبار کلید یا انبار اعتماد API مشخص کنید. نام فقط می‌تواند حاوی نویسه‌های الفباعددی باشد:

curl -X POST -H "Content-Type: text/xml" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores \
-d '<KeyStore name="myKeystore"/>' -u email:password

پاسخ نمونه:

{
 "certs" : [ ],
 "keys" : [ ],
 "name" : "myKeystore"
}

پس‌از ایجاد یک انبار کلید نام‌گذاری‌شده در محیط، می‌توانید فایل‌های JAR خود را که حاوی گواهینامه و کلید خصوصی است بااستفاده از میانای برنامه‌سازی کاربردی بارگذاری فایل JAR در انبار کلید بارگذاری کنید:

curl -X POST -H "Content-Type: multipart/form-data" \
-F file="@myKeystore.jar" -F password={key_pass} \ "https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/{myKeystore}/keys?alias={key_alias}" \
-u email:password

که در آن گزینه -F مسیر فایل JAR را مشخص می‌کند.

در این تماس، دو پارامتر پُرسمان را مشخص می‌کنید:

  • alias - گواهینامه و کلید را در انبار کلید شناسایی می‌کند. وقتی میزبان مجازی ایجاد می‌کنید، به گواهی و کلید با نام مستعار آن ارجاع می‌دهید.
  • ‫password - گذرواژه کلید خصوصی. اگر کلید خصوصی گذرواژه ندارد، این پارامتر را حذف کنید.

تأیید کنید که انبار کلیدتان به‌درستی بارگذاری شده است:

curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/myKeystore \
-u email:password

پاسخ نمونه:

{  
 "certs" : [ "myCertificate" ],
 "keys" : [ "myKey" ],
 "name" : "myKeystore"
}

ایجاد فروشگاه مطمئن

میاناهای برنامه‌سازی کاربردی که برای ایجاد مخزن اعتماد استفاده می‌کنید همان‌هایی هستند که برای ایجاد مخزن کلید استفاده می‌شوند. تنها تفاوت این است که فایل گواهینامه را به‌صورت فایل PEM به‌جای فایل JAR ارسال می‌کنید.

اگر گواهینامه بخشی از زنجیره است، باید همه گواهینامه‌های زنجیره را به‌صورت جداگانه در مخزن اعتماد بارگذاری کنید یا فایل واحدی حاوی همه گواهینامه‌ها ایجاد کنید و بین هر گواهینامه در فایل خط جدیدی اضافه کنید. گواهینامه نهایی معمولاً توسط صادرکننده گواهینامه امضا می‌شود. برای مثال، در truststore، گواهینامه کارخواه، client_cert_1، و گواهینامه صادرکننده گواهینامه کارخواه، ca_cert، را بارگذاری می‌کنید.

درطول اصالت‌سنجی «امنیت لایه انتقال» دوطرفه، اصالت‌سنجی کارخواه زمانی موفقیت‌آمیز است که سرور client_cert_1 را به‌عنوان بخشی از فرایند دست دادن «امنیت لایه انتقال» به کارخواه ارسال کند.

یا گواهینامه دومی دارید، client_cert_2، که با همان گواهینامه، ca_cert، امضا شده است. بااین‌حال، client_cert_2 را در انبار مطمئن بارگذاری نمی‌کنید. ‫truststore همچنان حاوی client_cert_1 و ca_cert است.

وقتی سرور client_cert_2 را به‌عنوان بخشی از دست دادن TLS ارسال می‌کند، درخواست موفقیت‌آمیز است. دلیل این است که Edge اجازه می‌دهد درستی‌سنجی «امنیت لایه انتقال» موفقیت‌آمیز باشد، حتی اگر client_cert_2 در truststore وجود نداشته باشد اما با گواهینامه‌ای که در truststore وجود دارد امضا شده باشد. اگر گواهینامه CA ، ca_cert، را از truststore بردارید، درستی‌سنجی «امنیت لایه انتقال» ناموفق خواهد بود.

بااستفاده از ایجاد «انبار کلید» یا «انبار اطمینان»، همان میانای برنامه‌سازی کاربردی که برای ایجاد انبار کلید استفاده می‌کنید، انبار اطمینان خالی در محیط ایجاد کنید:

curl -X POST -H "Content-Type: text/xml" -d \
'<KeyStore name="myTruststore"/>' \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores \
-u email:password

بااستفاده از API بارگذاری گواهی در مخزن اعتماد، گواهی را به‌عنوان فایل PEM در مخزن اعتماد بارگذاری کنید:

curl -X POST -H "Content-Type: multipart/form-data" -F file="@trust.pem" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/myTruststore/certs?alias=myTruststore \
-u email:password

که در آن گزینه -F مسیر فایل PEM را مشخص می‌کند.

حذف کردن keystore یا truststore

بااستفاده از API حذف کردن keystore یا truststore می‌توانید keystore یا truststore را حذف کنید:

curl -X DELETE \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/keystores/myKeystoreName \
-u email:password

پاسخ نمونه:

{
 "certs" : [ ],
 "keys" : [ ],
 "name" : "myKeystoreName"
}

اگر انبار کلید یا انبار اعتماد را که توسط میزبان مجازی یا نقطه پایانی/هدف/سرور هدف استفاده می‌شود حذف کنید، همه تماس‌های «میانای برنامه‌سازی کاربردی» ازطریق میزبان مجازی یا نقطه پایانی/سرور هدف هدف ناموفق خواهد بود.