Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rulesets): add scope validation to oas{2,3}-operation-security-defined rules #2538

Merged
merged 1 commit into from
Sep 20, 2023
Merged

feat(rulesets): add scope validation to oas{2,3}-operation-security-defined rules #2538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 97 additions & 58 deletions packages/rulesets/src/oas/__tests__/oas2-operation-security-defined.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,21 @@ import testRule from './__helpers__/tester';

testRule('oas2-operation-security-defined', [
{
name: 'a correct object (just in body)',
name: 'valid case',
document: {
swagger: '2.0',
securityDefinitions: {
apikey: {},
apikey: {
type: 'apiKey',
name: 'api_key',
in: 'header',
},
},
security: [
{
apikey: [],
},
],
paths: {
'/path': {
get: {
Expand All @@ -25,37 +34,44 @@ testRule('oas2-operation-security-defined', [
},

{
name: 'a correct object (API-level security)',
name: 'valid and invalid object',
document: {
swagger: '2.0',
securityDefinitions: {
apikey: {},
apikey: {
type: 'apiKey',
name: 'api_key',
in: 'header',
},
oauth2: {
type: 'oauth2',
flows: 'accessCode',
authorizationUrl: 'https://example.com/api/oauth/dialog',
tokenUrl: 'https://example.com/api/oauth/token',
scopes: {
'write:pets': 'modify pets in your account',
'read:pets': 'read your pets',
},
},
},
security: [
{
apikey: [],
basic: [],
oauth2: ['write:pets'],
},
],
paths: {
'/path': {
get: {},
{},
{
oauth2: ['write:users', 'read:users'],
},
},
},
errors: [],
},

{
name: 'invalid object',
document: {
swagger: '2.0',
securityDefinitions: {},
],
paths: {
'/path': {
'/users': {
get: {
security: [
{
apikey: [],
bearer: [],
oauth2: [],
},
],
},
Expand All @@ -64,45 +80,32 @@ testRule('oas2-operation-security-defined', [
},
errors: [
{
message: 'Operation "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['paths', '/path', 'get', 'security', '0', 'apikey'],
message: 'API "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['security', '0', 'basic'],
severity: DiagnosticSeverity.Warning,
},
],
},

{
name: 'invalid object (API-level security)',
document: {
swagger: '2.0',
securityDefinitions: {},
security: [
{
apikey: [],
},
],
paths: {
'/path': {
get: {},
},
{
message: '"write:users" must be listed among scopes.',
path: ['security', '2', 'oauth2', '0'],
severity: DiagnosticSeverity.Warning,
},
},
errors: [
{
message: 'API "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['security', '0', 'apikey'],
message: '"read:users" must be listed among scopes.',
path: ['security', '2', 'oauth2', '1'],
severity: DiagnosticSeverity.Warning,
},
{
message: 'Operation "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['paths', '/users', 'get', 'security', '0', 'bearer'],
severity: DiagnosticSeverity.Warning,
},
],
},

{
name: 'valid and invalid object',
name: 'missing securityDefinitions',
document: {
swagger: '2.0',
securityDefinitions: {
apikey: {},
},
paths: {
'/path': {
get: {
Expand All @@ -111,12 +114,18 @@ testRule('oas2-operation-security-defined', [
apikey: [],
basic: [],
},
{},
],
},
},
},
},
errors: [
{
message: 'Operation "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['paths', '/path', 'get', 'security', '0', 'apikey'],
severity: DiagnosticSeverity.Warning,
},
{
message: 'Operation "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['paths', '/path', 'get', 'security', '0', 'basic'],
Expand All @@ -126,28 +135,58 @@ testRule('oas2-operation-security-defined', [
},

{
name: 'valid and invalid object (API-level security)',
name: 'invalid scopes in Security Scheme object',
document: {
swagger: '2.0',
securityDefinitions: {
apikey: {},
},
security: [
{
apikey: [],
basic: [],
authorizationCode: {
type: 'oauth2',
flows: 'accessCode',
authorizationUrl: 'https://example.com/api/oauth/dialog',
tokenUrl: 'https://example.com/api/oauth/token',
scopes: null,
},
],
noFlows: {
type: 'oauth2',
},
client: {
type: 'oauth2',
flows: {
clientCredentials: null,
},
},
},
paths: {
'/path': {
get: {},
get: {
security: [
{
noFlows: ['read:users'],
authorizationCode: ['write:users'],
},
{
noFlows: [],
client: ['read:users'],
},
],
},
},
},
},
errors: [
{
message: 'API "security" values must match a scheme defined in the "securityDefinitions" object.',
path: ['security', '0', 'basic'],
message: '"read:users" must be listed among scopes.',
path: ['paths', '/path', 'get', 'security', '0', 'noFlows', '0'],
severity: DiagnosticSeverity.Warning,
},
{
message: '"write:users" must be listed among scopes.',
path: ['paths', '/path', 'get', 'security', '0', 'authorizationCode', '0'],
severity: DiagnosticSeverity.Warning,
},
{
message: '"read:users" must be listed among scopes.',
path: ['paths', '/path', 'get', 'security', '1', 'client', '0'],
severity: DiagnosticSeverity.Warning,
},
],
Expand Down
Loading