הפניות CLI ל-Edge Microgateway

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X.
מידע

Edge Microgateway v. 3.3.x

סקירה כללית

באמצעות ה-CLI של Edge Microgateway אפשר לשלוט בכל ההיבטים של מכשיר Edge Microgateway מכונה.

ניהול האישורים

הפקודות cert מאפשרות להתקין ולנהל את זוג המפתחות הציבורי/הפרטי שמשמש לחתימה על אסימונים למוכ"ז שלקוחות משתמשים בהם לביצוע קריאות מאובטחות דרך Edge מיקרו-שער. המפתחות מאוחסנים ב-Apigee Edge במפת ערכי מפתחות מוצפנת (KVM). Microsoft Edge Microgateway משתמש ב- מפתח ציבורי לאימות אסימונים למוכ"ז חתומים. המפתחות האלה נוצרים כשמריצים את endmicro להגדיר, כמו שמוסבר בהגדרה הגדרת Edge Microgateway. אפשר להשתמש בפקודות cert שמתוארות כאן כדי ליצור מחדש ולנהל את המפתחות האלה במקרה הצורך.

התקנת אישור

מתקינים את המפתחות ב-Key Value Map [מפות ערכי מפתחות מוצפן] ומחזירים את הערך מפתח ציבורי כפלט. זוגות של מפתחות בהיקף של ארגון מסוים.

שימוש

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-f, --force (אופציונלי) אם מפתח כבר מאוחסן ב-KVM המוצפן, מאלצים את ההחלפה שלו.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro cert install -o docs -e test -u jdoe@example.com -f

פלט

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

מחיקת אישור

המחיקה של זוג המפתחות עבור ארגון.

שימוש

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro cert delete -o docs -e test -u jdoe@example.com

פלט

deleting vault
Vault deleted!

בדיקת אישור

מוודא שבארגון שלכם מותקן אישור.

שימוש

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro cert check -o docs -e test -u jdoe@example.com

פלט (הצלחה)

checked cert successfully

פלט (כשל)

אם האישור לא קיים, תוחזר שגיאה.

לקבלת המפתח הציבורי

הפונקציה מחזירה את המפתח הציבורי של הארגון שצוין. לא נדרש אימות.

שימוש

edgemicro cert public-key -o [organization] -e [environment]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro cert public-key -o docs -e test

פלט (דוגמה)

-----BEGIN CERTIFICATE-----

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=?

-----END CERTIFICATE-----

הגדרת Edge Microgateway של Apigee Edge Cloud

המדיניות מאפשרת לפעול ב-Edge Microgateway באמצעות מכונה של Apigee Edge Cloud. הוא גולש ופועל רצף של פקודות לפריסת שרת proxy לאימות ב-Edge, יצירת אימות אסימונים ולעדכן קובצי תצורה. כדי לקבל דוגמה מלאה, אפשר לעיין במאמר הגדרה ו הגדרת Edge Microgateway.

שימוש

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-r, --url (אופציונלי) מציין את הכינוי של המארח הווירטואלי עבור Organization:environment. לצפייה מסמכי תיעוד של Edge למידע על מארחים וירטואליים. ברירת מחדל: org-env.apigee.net
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה הוא בפורמט ./config/config.yaml. (נוספה גרסה 2.4.x)
-x, --proxyName (אופציונלי) מגדיר את הנתיב הבסיסי עבור שרת ה-proxy edgemicro-auth. אם שרת ה-proxy מסוג edgemicro-auth נפרס בנתיב שונה מברירת המחדל, /edgemicro-auth, התכונה הזו מאפשרת להגדיר את הנתיב החדש ב-Edge מיקרו-שער. כברירת מחדל, הנתיב הבסיסי הוא /edgemicro-auth. (נוספה) v2.4.x)
-t, --token (אופציונלי) מאפשר להשתמש באסימון OAuth לצורך אימות במקום שם משתמש/סיסמה. כדאי לקרוא גם את המאמר קריאות ל-API מאובטח באמצעות אסימון גישה מסוג OAuth2. לדוגמה:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (אופציונלי) משנה את המארחים הווירטואליים שמוגדרים כברירת מחדל, 'default,secure'. כדאי להשתמש באפשרות הזו אם הגדרתם מארחים וירטואליים ארגון קצה:סביבה אחרת מברירות המחדל האלה. אפשר לעיין במסמכי התיעוד של Edge כדי ללמוד על מארחים וירטואליים.
-d, --debug (אופציונלי) מספקים מידע על תוצאות ניפוי הבאגים.
-h, --help מידע על השימוש בפלט.

הערות לשימוש

הפקודה הזו שומרת את פרטי ההגדרות ב ~/.edgemicro/org-env-config.yaml.

דוגמה

edgemicro configure -o docs -e test -u jdoe@example.com

פלט

אם הפעולה הצליחה, הפקודה תחזיר קבוצת מקשים שצריך להשתמש בהם כשמפעילים את Edge. מיקרו-שער.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

המערכת יוצרת מפתחות

הפקודה genkeys יוצרת זוג של מפתח וסוד שמשמש את Edge Microgateway כדי לאמת את עצמו בזמן פרסום אסינכרוני של נתוני ניתוח ב-Apigee Edge.

שימוש

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-t, --token (אופציונלי) מאפשר להשתמש באסימון OAuth לצורך אימות במקום שם משתמש/סיסמה. כדאי לקרוא גם את המאמר קריאות ל-API מאובטח באמצעות אסימון גישה מסוג OAuth2. לדוגמה:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help מידע על השימוש בפלט.

הערות לשימוש

כאשר הפעולה הצליחה, הפקודה תחזיר שלושה פריטים. הראשונה היא כתובת URL שצריך להוסיף את קובץ התצורה. השניים האחרים הם זוג מפתחות, הנדרש בעת הפעלת Edge. מכונת Microgateway.

  • bootrap URL: כתובת ה-URL הזו מפנה לשירות Apigee Edge שמאפשר מכונת Edge Microgateway כדי לשלוח ניתוח נתונים אל Apigee Edge. צריך להעתיק את כתובת ה-URL הזו בקובץ התצורה של Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
  • key: המפתח. המפתח הזה והסוד נדרשים כקלט ל-CLI שמשמשת להפעלת מופע של Edge Microgateway.
  • Secret (סוד): הסוד.

דוגמה

edgemicro genkeys -o docs -e test -u jdoe@example.com

פלט (דוגמה)

אם הפעולה הצליחה, הפקודה תחזיר קבוצת מקשים שצריך להשתמש בהם כשמפעילים את Edge. מיקרו-שער.

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

הגדרת Edge Microgateway של ענן פרטי של Apigee Edge

הגדרת Edge Microgateway לעבודה עם התקנה בענן הפרטי של Apigee Edge.

שימוש

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-r, --runtime-url מציינת את כתובת ה-URL של סביבת זמן הריצה של המכונה של הענן הפרטי.
-m, --mgmt-url כתובת ה-URL של שרת הניהול של המכונה של הענן הפרטי.
-v, --virtualHosts רשימה מופרדת בפסיקים של מארחים וירטואליים עבור Organization:environment. ברירת מחדל 'default,secure'.
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה הוא בפורמט ./config/config.yaml. (נוספה גרסה 2.4.x)
-t, --token (אופציונלי) מאפשר להשתמש באסימון OAuth לצורך אימות במקום שם משתמש/סיסמה. כדאי לקרוא גם את המאמר קריאות ל-API מאובטח באמצעות אסימון גישה מסוג OAuth2. לדוגמה:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (אופציונלי) מספקים מידע על תוצאות ניפוי הבאגים.
-h, --help מידע על השימוש בפלט.

הערות לשימוש

הפקודה הזו שומרת את פרטי ההגדרות ב ~/.edgemicro/org-env-config.yaml.

דוגמה

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

פלט

אם הפעולה הצליחה, הפקודה תחזיר קבוצת מקשים שצריך להשתמש בהם כשמפעילים את Edge. מיקרו-שער.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Microsoft Edge Microgateway

לפני שמפעילים את Edge Microgateway, צריך להריץ את הגדרת ה-Endmicro. (Public Cloud) או dgemicro private configuration (ענן פרטי). ההגדרה הפקודה תחזיר את ערכי המפתח והסוד הנדרשים כדי להפעיל את Edge Microgateway.

שימוש

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-k, --key ערך המפתח שמוחזר כשמריצים את 'edgemicro configure' הפקודה.
-s, --secret ערך הסוד שמוחזר כשמריצים את "edgemicro configure" הפקודה.
-p, --processes (אופציונלי) מספר התהליכים שיש להתחיל. ברירת מחדל: מספר הליבות המערכת.
-d, --pluginDir (אופציונלי) נתיב מוחלט לספריית יישומי הפלאגין.
-r, --port (אופציונלי) מבטל את מספר היציאה שצוין קובץ אחד (/.edgemicro/org-env-config.yaml). ברירת מחדל: 8,000
-c, --cluster

(אופציונלי) מפעיל את Edge Microgateway במצב אשכול.

הערה: החל מגרסה 2.3.1 של האפשרות הזו הוסרה. בגרסה 2.3.1 ובגרסאות מאוחרות יותר, Edge Micro תמיד מתחיל במצב אשכול.

-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה הוא בפורמט ./config/config.yaml. (נוספה גרסה 2.4.x)
-u, --configUrl (אופציונלי) המדיניות הזו מציינת נקודת קצה (endpoint) שממנה יוריד את ההגדרה של Edge Microgateway שלה חדש. (נוספה גרסה 2.5.x)
-d, --debug (אופציונלי) מספקים מידע על תוצאות ניפוי הבאגים.
-h, --help מידע על השימוש בפלט.

הגדרת היציאה

הפקודה start מאפשרת לציין מספר יציאה כדי לשנות את היציאה שצוינה בקובץ התצורה. אפשר גם לציין מספר יציאה באמצעות PORT במשתנה הסביבה. לדוגמה:

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

או

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

אם היציאה נמצאת בשימוש, Edge Microgateway תחזיר שגיאה.

מידע על אשכולות

Edge Microgateway משתמש ב-Node.js אשכול כדי להפעיל אשכולות. השימוש באשכולות מאפשר ל-Edge Microgateway את היתרונות של מערכות מרובות ליבות. מידע נוסף זמין במסמכי התיעוד של Node.js.

דוגמה

edgemicro start -o docs -e test -k abc123 -s xyz456

פלט לדוגמה:

...

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

ניהול אסימונים

פקודות token מאפשרות לקבל, לפענח ולאמת גישת OAuth2 חתומה לאסימונים אישיים. ראו גם קריאות מאובטחות ל-API באמצעות אסימון גישה מסוג OAuth2.

פענוח של אסימון

מפענח אסימון למוכ"ז חתום ומקודד ל-JSON JWT בפורמט טקסט פשוט (Java Web Token) בווקטור יהיה זהה, אסימון מעביר מידע על אפליקציית המפתחים של Apigee Edge שסיפקה את מפתחות ששימשו ליצירת האסימון, כולל שם האפליקציה, client_id, רשימת המוצרים ועוד.

שימוש

edgemicro token decode -f [filename]

פרמטרים

פרמטרים תיאור
-f, --file שם הקובץ שמכיל את אסימון ה-JWT לפענוח.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro token decode -f token.jwt

פלט (דוגמה)

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

יצירת אסימון

יוצרת אסימון למוכ"ז חתום. האסימון מאפשר לאפליקציות לקוח לבצע קריאות מאומתות ל-API ל-Edge Microgateway. האסימון הוא אסימון אינטרנט מסוג JSON (JWT) שתואם ל-OAuth 2.0. הוא נדרש כ- להזין את הערכים של מפתח הצרכן (מזהה לקוח) וסוד הצרכן (סוד לקוח) של למפתחים ב-Apigee Edge. ראו גם קריאות מאובטחות ל-API באמצעות אסימון גישה מסוג OAuth2.

שימוש

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-1, --key מזהה הלקוח מאפליקציית המפתח שמשויך ל-Microgateway שרת proxy.
-s, --secret סוד הלקוח מאפליקציית המפתח שמשויכת לחשבון Microgateway שרת proxy.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

פלט (דוגמה)

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

אפשר גם ליצור JWT באמצעות ה-Management API:

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

כאשר:

  • $ORG הוא שם הארגון שלך ב-Edge (עליך להיות מנהל חשבון ארגוני).
  • $ENV הוא סביבה בארגון (כמו 'בדיקה' או 'מוצר').
  • $CLIENT_ID הוא מזהה הצרכן באפליקציית המפתח שיצרת בעבר.
  • $CLIENT_SECRET הוא סוד הצרכן באפליקציית המפתח שיצרת בעבר.

אימות אסימון

מאמתת אסימון למוכ"ז חתום מול המפתח הציבורי שמאוחסן ב-Apigee Edge עבור שצוין של הארגון והסביבה.

שימוש

edgemicro token verify -o [org] -e [env] -f [filename]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-f, --file שם הקובץ שמכיל את ה-JWT לאימות.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro token get -o docs -e test -f token.jwt

פלט לדוגמה של אסימון חוקי

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

פלט לדוגמה של אסימון לא חוקי

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

פלט לדוגמה של אסימון שפג תוקפו

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

אתחול הגדרה חדשה של Edge Microgateway

מריצים את הפקודה הזו פעם אחת אחרי שמתקינים בפעם הראשונה את Edge Microgateway. יצירה של ברירת מחדל חדשה קובץ תצורה: ~/.edgemicro/default.yaml.

שימוש

edgemicro init

פרמטרים

פרמטרים תיאור
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה הוא בפורמט ./config/config.yaml. (נוספה גרסה 2.4.x)
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro init

פלט (הצלחה)

config initialized to /MyHome/.edgemicro/default.yaml

המערכת מאמתת את ההגדרה של Edge Microgateway

מוודאת ש-Edge Microgateway מוגדרת כראוי.

שימוש

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

פרמטרים

דוגמה

edgemicro verify -o docs -e test -k abc123 -s xyz456

פלט (הצלחה)

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

בדיקת הסטטוס של אשכול המיקרו-שער

כברירת מחדל, אפליקציית Edge Microgateway מתחילה במצב אשכול. אפשר להשתמש בפקודה הזו כדי לבדוק של האשכול.

שימוש

edgemicro status

פרמטרים

פרמטרים תיאור
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro status

פלט (הצלחה)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

הפסקת אשכול המיקרו-שער

הפסקת אשכול Edge Microgateway.

שימוש

edgemicro stop

פרמטרים

פרמטרים תיאור
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro stop

פלט (הצלחה)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

טעינה מחדש של אשכול המיקרו-שער

ההגדרה מאפשרת הפעלה מחדש ללא הפסקה לאחר שינוי הגדרה. טעינה מחדש של Edge Microgateway באמצעות שליפת מערך חדש של הגדרות אישיות.

שימוש

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-k, --key ערך המפתח שמוחזר כשמריצים את 'edgemicro configure' הפקודה.
-s, --secret ערך הסוד שמוחזר כשמריצים את "edgemicro configure" הפקודה.
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro reload -o docs -e test -k abc123 -s xyz456

פלט (הצלחה)

...

Reload Completed Successfully

שדרוג שרת ה-proxy ל-Endmicro-auth

כדי להשתמש ברוטציית מפתחות, צריך שרת proxy ל-Endmicro-auth פרוס בארגון שלך ב-Apigee Edge. (נוספה גרסה 2.5.x)

הערה: אם הגדרתם את מכונת Edge Micro הנוכחית בעבר בגרסה 2.5.2, עליך לשדרג את שרת ה-proxy הזה אם ברצונך להשתמש ברוטציית מפתחות. צריך רק מבצעים את השדרוג פעם אחת.

שימוש

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-v, --virtualhost (אופציונלי) המארח הווירטואלי של שרת ה-proxy.
-b, --baseuri (אופציונלי) ה-URI הבסיסי לארגון שלכם ב-Apigee Edge. ברירת המחדל היא הבסיס ה-URI לפריסות בענן של Apigee הוא api.enterprise.apigee.com. בפריסות בארגון, כתובת ה-URL הבסיסית עשויה להיות שונה.

דוגמה

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

פלט (הצלחה)

אם הפקודה מסתיימת בלי שגיאות, היא תחזיר פלט דומה לזה:

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

שדרוג Key Value Map (KVM)

משתמשים בפקודה edgemicro upgradekvm כדי לשדרג את ה-KVM ב-Apigee של הארגון. עליך לשדרג את KVM אם ברצונך להשתמש ברוטציית מפתחות.

שימוש

Edge לענן ציבורי:

edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]

Edge לענן פרטי:

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

פרמטרים

פרמטרים תיאור
-o, --org ארגון Apigee שעבורו הגדרתם את Edge Microgateway.
-e, --env סביבה שהגדרת עבורה את Edge Microgateway.
-k, --key ערך המפתח שמוחזר כשמריצים את 'edgemicro configure' הפקודה.
-s, --secret ערך הסוד שמוחזר כשמריצים את "edgemicro configure" הפקודה.
-p, --proxyuri ה-URI של שרת ה-proxy ל-Endmicro_auth

ענן ציבורי של Edge: אופציונלי.
ענן פרטי של Edge: חובה.

דוגמה לענן ציבורי של Edge:

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

דוגמה לענן פרטי של Edge:

-p 'https://[hostname]/edgemicro-auth'

דוגמה

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

פלט (הצלחה)

אם הפקודה מסתיימת בלי שגיאות, היא תחזיר פלט דומה לזה:

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

רוטציית מפתחות

משתמשים בפקודה edgemicro rotatekey כדי לבצע רוטציה של זוגות המפתחות הציבוריים/הפרטיים ששימשו ליצירת אסימוני ה-JWT ששימשו לאבטחת OAuth ב-Edge Microgateway.

מידע נוסף זמין במאמר מפתחות JWT מסתובבים.

שימוש

Edge לענן ציבורי:

edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]

Edge לענן פרטי:

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

פרמטרים

פרמטרים תיאור
-o, --org (חובה) ארגון Apigee שהגדרת בשבילו את Edge Microgateway.
-e, --env (חובה) סביבה שהגדרת עבורה את Edge Microgateway.
-k, --key ערך המפתח שמוחזר כשמריצים את 'edgemicro configure' הפקודה.
-s, --secret ערך הסוד שמוחזר כשמריצים את "edgemicro configure" הפקודה.
-p נתיב למפתח פרטי מותאם אישית לשימוש ב-Apigee Edge. (נוסף 3.1.6)
-c נתיב לאישור מותאם אישית לשימוש ב-Apigee Edge. (נוסף 3.1.6)
-n, --nbf

יש להגדיר את משך הזמן בדקות עד שמפתח פרטי חדש ייכנס לתוקף. הזה עם עיכוב מאפשר זמן רענון של מופעי Microsoftgate מקש. כדאי להגדיר שהעיכוב יהיה ארוך יותר מהגדרת התצורה של config_change_poll_internal, שהאורך שלו הוא 10 דקות כברירת מחדל. מידע נוסף זמין בקטע הגדרת ערך 'לא לפני' עיכוב. (נוסף 3.1.6)

הערה: אם אתה משתמש באפשרות הזו בגרסאות של edgemicro-auth ישנות יותר את הגרסה שמופצת עם Edge Microgateway 3.1.6, המערכת מתעלמת מהדגל.

-i, --kid (אופציונלי) מזהה שמשמש להתאמה למפתח ספציפי. Microsoft Edge Microgateway משתמש בערך הזה כדי לבחור מתוך קבוצה של מפתחות במהלך רוטציית המפתחות. אם הפרמטר הזה מושמט (מומלץ), Edge Microgateway יוצר מפתח שמבוסס על חותמת זמן. מידע נוסף זמין בסעיף 4.5 של למפרט של מפתח JSON אינטרנט.
-r, --rotatekeyuri סיבוב ה-URI של המפתח.

ענן ציבורי של Edge: אופציונלי.
ענן פרטי של Edge: חובה.

דוגמה לענן ציבורי:

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

דוגמה לענן פרטי של Edge:

-r '[hostname]/edgemicro-auth/rotateKey'

דוגמה

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

פלט (הצלחה)

אם הפקודה מסתיימת בלי שגיאות, היא תחזיר פלט דומה לזה:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

לאחר הסיבוב, ניתן לראות בממשק המשתמש של Edge שמפתחות חדשים נוספו למיקרו-שער KVM.

דוגמה

בדוגמה הזו נעשה שימוש בדגלים -p ו--c כדי לציין את הנתיב לצמד של מפתח/אישור פרטי. בעזרת האפשרויות האלה אפשר להעביר מפתח פרטי ואישור בהתאמה אישית להתאים בין מכשירים.

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

מעקב תמידי

ביטול המפתחות

משתמשים בפקודה edgemicro revokekeys כדי לבטל את המפתח ואת פרטי הכניסה הסודיים של תצורת Microgateway של Edge.

שימוש

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

פרמטרים

פרמטרים תיאור
-o, --org (חובה) ארגון Apigee שהגדרת בשבילו את Edge Microgateway.
-e, --env (חובה) סביבה שהגדרת עבורה את Edge Microgateway.
-u, --username (נדרשים -u או -t) שם המשתמש שלכם ב-Apigee. עליך להיות מנהל חשבון ארגוני עבור הנכס שצוין של הארגון. הפרמטר הזה לא נדרש אם מציינים במקום זאת את הפרמטר -t.
-p, --password (אופציונלי) הסיסמה שלכם. אם לא תספקו את הפרמטר הזה, תוצג לכם בקשה בשורת הפקודה.
-k, --key (חובה) המפתח שרוצים לבטל.
-s, --secret (חובה) הסוד לביטול.
-t, --token (שניהם נדרשים -u או -t) מאפשר להשתמש באסימון OAuth לצורך אימות במקום שם משתמש/סיסמה. אם צוין -t, הפרמטר -u אינו נדרש. כדאי לקרוא גם את המאמר קריאות ל-API מאובטח באמצעות אסימון גישה מסוג OAuth2. לדוגמה:
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

דוגמאות

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

בהצלחה, תופיע ההודעה הבאה:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully