הפניות CLI ל-Edge Microgateway

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

Edge Microgateway v. 3.3.x

סקירה כללית

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

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

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

התקנת אישור

התקנת המפתחות במפת ערכי מפתח מוצפנת (KVM) והחזרת המפתח הציבורי כפלט. צמדי מפתחות מוגבלים לארגון שצוין.

שימוש

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 לפעול עם מופע Cloud Apigee Edge. הוא אורז ומבצע רצף פקודות כדי לפרוס שרת 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. (נוסף v2.4.x)
-x, --proxyName (אופציונלי) מגדיר את נתיב הבסיס לשרת ה-proxy של edgemicro-auth. אם שרת ה-proxy של edgemicro-auth פרוס בנתיב שונה מברירת המחדל, /edgemicro-auth, התכונה הזו תאפשר לכם להגדיר את הנתיב החדש ב-Edge Microgateway. כברירת מחדל, הנתיב הבסיסי הוא /edgemicro-auth. (נוסף v2.4.x)
-t, --token (אופציונלי) מאפשר לך להשתמש באסימון OAuth לצורך אימות במקום בשם משתמש/סיסמה. כדאי לעיין גם בקטע קריאות ל-API מאובטח באמצעות אסימון גישה מסוג OAuth2. למשל:

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

הערות שימוש

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

דוגמה

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

פלט

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

...

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.

  • Botstrap 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 Microgateway.

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. (נוסף v2.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 Microgateway.

...

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

edgemicro configuration complete!

הפעלת Edge Microgateway

לפני שמפעילים את Edge Microgateway, צריך להריץ את edgemicro configuration (ב-Public Cloud) או את edgemicro privacy setting (ענן פרטי). פקודת ההגדרה מחזירה את ערכי המפתח והסוד שנדרשים להפעלת 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. (נוסף v2.4.x)
-u, --configUrl (אופציונלי) ההגדרה הזאת קובעת את נקודת הקצה שממנה יוריד Edge Microgateway את קובץ התצורה. (נוסף v2.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.

פענוח אסימון

מתבצע פענוח של אסימון מקודד וחתום לייצוג JWT (Java Web Token) בפורמט JSON פשוט. אסימון שמעביר מידע על אפליקציית המפתחים של 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 Web Token (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 מזהה הלקוח מאפליקציית המפתח שמשויך לשרת proxy שתומך ב-Microgateway.
-s, --secret סוד הלקוח מאפליקציית המפתחים המשויכת לשרת ה-proxy שתומך ב-Microgateway.
-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 באמצעות ממשק ה-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 היא בארגון שלך (למשל test או prod).
  • $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. (נוסף v2.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 לאימות קצה

כדי להשתמש ברוטציית מפתחות, צריך להיות לכם שרת proxy משודרג עם הרשאות קצה בארגון Apigee Edge. (נוסף v2.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

שדרוג מפת הערכים של המפתח (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 ל-edgemicro_auth

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

דוגמה ל-Edge Public Cloud:

 -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

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

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

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

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

דוגמה לשימוש ב-Public Cloud:

-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 forever כדי לנהל את התהליך Forever, כלי של Node.js שמפעיל אפליקציית Node.js באופן אוטומטי למקרה שהאפליקציה מושבתת או שיש בה שגיאה. למידע נוסף, אפשר לקרוא את המאמר מעקב לתמיד.

שימוש

צריך להגדיר את משתני הסביבה האלה לפני שמריצים את הפקודה edgemicro forever:

  • EDGEMICRO_ORG – הארגון Apigee שעבורו הגדרת את Edge Microgateway.
  • EDGEMICRO_ENV – סביבה שעבורה הגדרת את Edge Microgateway.
  • EDGEMICRO_KEY - ערך המפתח שהוחזר ושהוחזר כשהרצתם את הפקודה 'edgemicro configuration'.
  • EDGEMICRO_SECRET - הערך הסודי שהוחזר ומוחזר כשהרצתי את הפקודה 'edgemicro configuration'.
edgemicro forever -f [forever_file] -a [start|stop]

פרמטרים

פרמטרהתיאור
-f, --fileמציין את מיקום הקובץ forever.json.
-a, --actionstart או stop. ברירת המחדל היא להתחיל.

לדוגמה:

כדי להתחיל לתמיד:

edgemicro forever -f ~/mydir/forever.json -a start

כדי להפסיק לתמיד:

edgemicro forever -a stop

ביטול המקשים

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

שימוש

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