Verzoek om de **-opmerking aan te scherpen en een prominentere plek te geven dan een voetnoot bij deze tabel.
Wat betreft de aanscherping:
Het URI-pad en de query strings zijn versleuteld bij gebruik van TLS. Dus als TLS niet wordt onderbroken in systemen die niet onder controle van de betrokken client- en serverorganisatie staan, dan is logging geen enkel probleem. En het lijkt onlogisch dat TLS wordt onderbroken in systemen waar je geen controle over hebt. Scherper zou zijn iets van: (1) TLS versleutelt URI-pad en query strings, dus ook de sensitive information hierin, (2) maak beleid op logging van gevoelige informatie bij de TLS-uiteinden en bij onderbreking van de TLS-versleuteling. Dit geldt niet alleen voor de URI's, maar ook voor logging van headers en bodies (waar uiteraard ook sensitive information in kan zitten).
Wat betreft de promintere plek:
Deze noot kan essentieel blijken om G2G M2M REST API's te ontwerpen die voldoen aan de ADR en een goede DX hebben. Als een sleutel zoals een BSN niet in de URI opgenomen mag worden, dan doet dit afbreuk aan andere Design Rules, zoals gebruik van HTTP methods en modelleren van sub-resources. Daarom mag deze noot wel een op zichzelf staande alinea of paragraaf worden.
En verder zijn inmiddels niet alle Design Rules in de tabel nog opgenomen in modules, dus daar is een update gewenst.
Zie ook deze PR op de ADR:
Logius-standaarden/API-Design-Rules#277
Verzoek om de **-opmerking aan te scherpen en een prominentere plek te geven dan een voetnoot bij deze tabel.
Wat betreft de aanscherping:
Het URI-pad en de query strings zijn versleuteld bij gebruik van TLS. Dus als TLS niet wordt onderbroken in systemen die niet onder controle van de betrokken client- en serverorganisatie staan, dan is logging geen enkel probleem. En het lijkt onlogisch dat TLS wordt onderbroken in systemen waar je geen controle over hebt. Scherper zou zijn iets van: (1) TLS versleutelt URI-pad en query strings, dus ook de sensitive information hierin, (2) maak beleid op logging van gevoelige informatie bij de TLS-uiteinden en bij onderbreking van de TLS-versleuteling. Dit geldt niet alleen voor de URI's, maar ook voor logging van headers en bodies (waar uiteraard ook sensitive information in kan zitten).
Wat betreft de promintere plek:
Deze noot kan essentieel blijken om G2G M2M REST API's te ontwerpen die voldoen aan de ADR en een goede DX hebben. Als een sleutel zoals een BSN niet in de URI opgenomen mag worden, dan doet dit afbreuk aan andere Design Rules, zoals gebruik van HTTP methods en modelleren van sub-resources. Daarom mag deze noot wel een op zichzelf staande alinea of paragraaf worden.
En verder zijn inmiddels niet alle Design Rules in de tabel nog opgenomen in modules, dus daar is een update gewenst.
Zie ook deze PR op de ADR:
Logius-standaarden/API-Design-Rules#277