Skip to content

Commit 566d068

Browse files
chore(rules): merge validation logic from main (from feature/356-sak15)
Signed-off-by: Fredrik Nordlander <fredrik.nordlander@digg.se>
2 parents c4282a4 + c09d561 commit 566d068

File tree

11 files changed

+6671
-4357
lines changed

11 files changed

+6671
-4357
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,25 @@ För att begära en ny funktion:
5555
För att bidra med kod, dokumentation eller andra förbättringar:
5656

5757
1. Diskutera dina planer i förväg för att säkerställa att de stämmer överens med projektmålen.
58-
2. Kontrollera listan över öppna ärenden. Tilldela dig själv ett befintligt ärende eller skapa ett nytt.
59-
3. Följ projektkonventioner för tester, kodstil, dokumentation och commit-meddelanden.
60-
4. Förstå att bidrag kan avslås om de inte överensstämmer med projektets riktlinjer eller mål.
61-
5. Bekanta dig med [Pull Request-livscykeln](#pull-request-livscykel).
62-
6. Godkänn "inbound=outbound"-normen: dina bidrag kommer att vara under samma licens som projektet.
63-
7. [Signera dina commits](#dco---signoff-och-signering-av-en-commit).
58+
2. Kontrollera listan över öppna ärenden, saknas ett ärende för det tänkta bidraget skapar du ett nytt.
59+
3. Tilldela dig själv ett befintligt ärende genom att kommentera ärendet.
60+
4. Följ projektkonventioner för tester, kodstil, dokumentation och commit-meddelanden.
61+
5. Förstå att bidrag kan avslås om de inte överensstämmer med projektets riktlinjer eller mål.
62+
6. Bekanta dig med [Pull Request-livscykeln](#pull-request-livscykel).
63+
7. Godkänn "inbound=outbound"-normen: dina bidrag kommer att vara under samma licens som projektet.
64+
8. [Signera dina commits](#dco---signoff-och-signering-av-en-commit).
65+
66+
Kom igång med "good first issues", de har en begränsad omfattning och en tänkt lösning som redan har diskuterats inom projektet. Lämpligt för nya utvecklare som vill bidra och få bättre förståelse för bidragsprocessen.
67+
68+
Det finns också ärenden taggade med "ready to take", vilket är ärenden som redan har blivit åtminstone delvis lösta i diskussioner, så pass att det är tydligt vad som behöver göras härnäst.
69+
70+
Självklart kan du arbeta med vilket annat ärende du vill – "good first" och "ready to take" ärenden är bara de där omfattning och tidsram ofta är tydligare definierade. Pull requests för andra ärenden, eller helt nya problem, kan ta lite längre tid att granska om de inte passar in i vår nuvarande utvecklingscykel och det finns en risk att någon i teamet redan arbetar på ärendet.
71+
72+
Om du bestämmer dig för att lösa ett ärende, se till att kolla kommentarsfältet för att se om någon redan arbetar på en lösning. Om ingen gör det just nu, lämna gärna en kommentar där du skriver att du har börjat arbeta med det, så att andra inte råkar göra samma jobb.
73+
74+
Om någon har tagit på sig ett ärende men inte följer upp inom en vecka, går det bra att ta över – men lämna ändå en kommentar. Om det inte har varit någon aktivitet på ärendet på 7 till 14 dagar är det rimligt att anta att ingen jobbar på det.
75+
76+
6477

6578
## Återkoppling på ärenden och Pull Requests
6679

GUIDELINES.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Detta dokument specificerar reglerna som verktyget tillämpar.
7575
9. [Område: Säkerhet](#område-säkerhet)
7676
- [ID: SAK.09](#id-sak09)
7777
- [ID: SAK.10](#id-sak10)
78+
- [ID: SAK.15](#id-sak15)
7879
- [ID: SAK.18](#id-sak18)
7980
10. [Område: Förutsättningar](#område-förutsättningar)
8081
- [ID: FOR.02](#id-for02)
@@ -943,7 +944,7 @@ I exemplet ovan, så exemplifieras regeln med en kontroll av de query parametrar
943944

944945
## Område: Säkerhet
945946

946-
**Täckningsgrad: 9%**
947+
**Täckningsgrad: 11%**
947948

948949
### ID: SAK.09
949950

@@ -991,6 +992,29 @@ I exemplet ovan så kommer regeln att ge ett positivt utfall eftersom det finns
991992

992993
---
993994

995+
### ID: SAK.15
996+
997+
**Krav:** API-nycklar SKALL INTE inkluderas i URL eller querysträngen.
998+
999+
**Typ:** SKALL
1000+
1001+
**JSON Path Plus-uttryck:**
1002+
1003+
```
1004+
$.components.securitySchemes[?(@ && @.type=='apiKey')]
1005+
```
1006+
1007+
**Förklaring:**
1008+
Regeln kontrollerar, under förutsättning att ett security scheme är definierat, att om typen är 'apiKey', så får värdet för parametern 'in' inte vara 'query.
1009+
1010+
**Exempel:**
1011+
1012+
![alt text](images/sak15.png)
1013+
1014+
I exemplet ovan ger regeln ett negativt utfall, eftersom det definierade säkerhetsschemat 'ApiKeyQuery' har typen 'apiKey' och parametern 'in' är satt till 'query', vilket strider mot regeln.
1015+
1016+
---
1017+
9941018
### ID: SAK.18
9951019

9961020
**Krav:** OAuth version 2.0 eller senare BÖR användas för auktorisation.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Om du har frågor, funderingar, buggrapporter etc, vänligen kontakta [Digg - Ag
256256

257257
## Bidra
258258

259-
Om du vill bidra till projektet, vänligen följ instruktionerna i avsnittet [Contributing](CONTRIBUTING).
259+
Om du vill bidra till projektet, vänligen följ instruktionerna i avsnittet [Contributing](CONTRIBUTING.md).
260260

261261
## Utveckling
262262

REUSE.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ path = [
5050
"images/rest-api-profil.png",
5151
"images/sak09.png",
5252
"images/sak10.png",
53+
"images/sak15.png",
5354
"images/sak18.png",
5455
"images/ufn1-2.png",
5556
"images/ufn1.png",

apis/sak-api.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ components:
115115
scopes:
116116
write:pets: modify pets in your account
117117
read:pets: read your pets
118+
#Test for invalid types in security schemes
119+
ApiKeyQuery:
120+
type: apiKey
121+
in: query
122+
name: api_key
123+
124+
118125
schemas:
119126
Error:
120127
type: object

images/sak15.png

13.9 KB
Loading

0 commit comments

Comments
 (0)