Arkaluonteisemmat apit on julkaistava asiakasvarmenteella suojattuna. Lisäksi niihin tulee aina apikey. Julkaisijalla on täysi kontrolli kenelle hän apit julkaisee hyväksymällä tai hylkäämällä apikeyn tilauksia. Julkaisija tekee ensin normaalisti apikeyllä autentikoivan apin. Kun se toimii, tee desingin kautta tai suoraan planiin policy SSL Enforcement.

Mene proxy→entrypoint ja kohdassa jossa palvelun url on esim. /palvelu/ lisää tämän eteen /secure/ niin että lopputulos on /secure/palvelu/ . Kaikki liikenne /secure/-polun kautta suojataan asiakasvarmenteella. Asiakasvarmenteen tilaa kukin apin käyttäjä palvelusta https://api.helsinki.fi/certificateui

Tämän jälkeen apia voi käyttää esim. foo-koneelta  curl --key 20200529foo.it.helsinki.fi.key --cert 20200529foo.it.helsinki.fi.pem -H 'X-Api-Key: aabcdefgh' https://api.helsinki.fi/secure/palvelu/tarkempipolku

Arkaluonteisemmat apit on julkaistava asiakasvarmenteella suojattuna. Lisäksi niihin tulee aina apikey. Julkaisijalla on täysi kontrolli kenelle hän apit julkaisee hyväksymällä tai hylkäämällä apikeyn tilauksia. Julkaisija tekee ensin normaalisti apikeyllä autentikoivan apin. Kun se toimii, mene proxy→entrypoint ja kohdassa jossa palvelun url on esim. /palvelu/ lisää tämän eteen /secure/ niin että lopputulos on /secure/palvelu/ . Kaikki liikenne /secure/-polun kautta suojataan asiakasvarmenteella. Asiakasvarmenteen tilaa kukin apin käyttäjä palvelusta https://api.helsinki.fi/certificateui

TULOSSA 2023

EI VIELÄ TOIMINNASSA

SSL Enforcement policyn lisääminen

Policyn asetukset:

• Distinguish Name: Varmenteessa mukana oleva palvelimen tunniste/nimi.
• Requires SSL: Oletuksena päällä.
• Requires client authentication: Tämä asetus vaaditaan, jos pyynnössä halutaan varmistua siitä, että kutsuja on varmasti oikea.

Planikohtainen asiakassertifikaatti -policy

Planeille voit lisätä SSL Enforcement policyn joko silloin kun luot uutta plania, tai lisätä niitä jo valmiisiin planeihin.

• Siirry Plans välilehdelle
• Valitse plan jota haluat muokata (configure plan)
• Siirry Policies kohtaan
• Lisää SSL Enforcement policy

Oheisessa kuvassa on esimerkki planille luodusta SSL Enforcement policysta.

Apikohtainen asiakassertifikaatti -policy design-näkymästä

Lisää API kohtainen SLL Enforcement policy Design - välilehdeltä.

Policyyn voit määrittää, vaikuttaako se root pathiin (jokaiseen planiin ja polkuun API:n alla) vai ainoastaa johonkin tiettyyn polkuun.

Uuden polun voit määrittää painamalla sinistä + -painiketta alakulmasta.

Oheisessa kuvassa on toteutettu esimerkki SSL Enforcement -policysta message-center API:n viestinlähetys polulle.

Vanhaa tietoa?