Skip to content

fix endpoint, data field, and spec generation #40

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

Merged
merged 4 commits into from
Oct 19, 2022
Merged

fix endpoint, data field, and spec generation #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6ad978
fix endpoint generation, trailing slash
NikhilShahi Oct 19, 2022
3e9375f
only add request query params, headers, body to data fields and gener…
NikhilShahi Oct 19, 2022
615da96
add optional slashes at path end to regex
NikhilShahi Oct 19, 2022
cd9adde
fix endpoint risk score calculation
NikhilShahi Oct 19, 2022
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
36 changes: 19 additions & 17 deletions backend/src/services/data-field/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export class DataFieldService {
apiEndpoint: ApiEndpoint,
dataValue: any,
): void {
const existingMatch = `${dataSection}.${dataPath}`
const existingMatch = `${dataSection}${dataPath ? `.${dataPath}` : ""}`
const dataType = getDataType(dataValue)
if (!this.dataFields[existingMatch]) {
const dataField = new DataField()
Expand Down Expand Up @@ -214,31 +214,33 @@ export class DataFieldService {
this.dataFields = apiEndpoint.dataFields.reduce((obj, item) => {
return {
...obj,
[`${item.dataSection}.${item.dataPath}`]: item,
[`${item.dataSection}${item.dataPath ? `.${item.dataPath}` : ""}`]: item,
}
}, {})
this.updatedFields = {}
this.findPathDataFields(apiTrace.path, apiEndpoint)
this.findPairObjectDataFields(
DataSection.REQUEST_QUERY,
apiTrace.requestParameters,
apiEndpoint,
)
this.findPairObjectDataFields(
DataSection.REQUEST_HEADER,
apiTrace.requestHeaders,
apiEndpoint,
)
if (apiTrace.responseStatus < 400) {
this.findPairObjectDataFields(
DataSection.REQUEST_QUERY,
apiTrace.requestParameters,
apiEndpoint,
)
this.findPairObjectDataFields(
DataSection.REQUEST_HEADER,
apiTrace.requestHeaders,
apiEndpoint,
)
this.findBodyDataFields(
DataSection.REQUEST_BODY,
apiTrace.requestBody,
apiEndpoint,
)
}
this.findPairObjectDataFields(
DataSection.RESPONSE_HEADER,
apiTrace.responseHeaders,
apiEndpoint,
)
this.findBodyDataFields(
DataSection.REQUEST_BODY,
apiTrace.requestBody,
apiEndpoint,
)
this.findBodyDataFields(
DataSection.RESPONSE_BODY,
apiTrace.responseBody,
Expand Down
2 changes: 1 addition & 1 deletion backend/src/services/jobs/generate-endpoints-traces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ const generateEndpointsFromTraces = async (): Promise<void> => {
}
}
if (pathRegex.length > 0) {
pathRegex = String.raw`^${pathRegex}$`
pathRegex = String.raw`^${pathRegex}(/)*$`
const regexKey = `${trace.host}-${trace.method}-${pathRegex}`
if (regexToTracesMap[regexKey]) {
regexToTracesMap[regexKey].traces.push(trace)
Expand Down
36 changes: 20 additions & 16 deletions backend/src/services/jobs/generate-openapi-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,21 +120,23 @@ const generateOpenApiSpec = async (): Promise<void> => {
)
}
}
for (const requestParameter of requestParamters) {
const key = `${requestParameter.name}<>query`
parameters[key] = parseSchema(
parameters[key] ?? {},
parsedJsonNonNull(requestParameter.value, true),
)
}
for (const requestHeader of requestHeaders) {
const key = `${requestHeader.name}<>header`
parameters[key] = parseSchema(
parameters[key] ?? {},
parsedJsonNonNull(requestHeader.value, true),
)
if (requestHeader.name.toLowerCase() === "content-type") {
requestContentType = requestHeader.value.toLowerCase()
if (trace.responseStatus < 400) {
for (const requestParameter of requestParamters) {
const key = `${requestParameter.name}<>query`
parameters[key] = parseSchema(
parameters[key] ?? {},
parsedJsonNonNull(requestParameter.value, true),
)
}
for (const requestHeader of requestHeaders) {
const key = `${requestHeader.name}<>header`
parameters[key] = parseSchema(
parameters[key] ?? {},
parsedJsonNonNull(requestHeader.value, true),
)
if (requestHeader.name.toLowerCase() === "content-type") {
requestContentType = requestHeader.value.toLowerCase()
}
}
}
for (const responseHeader of responseHeaders) {
Expand All @@ -155,7 +157,9 @@ const generateOpenApiSpec = async (): Promise<void> => {
)
}

parseContent(requestBodySpec, requestBody, requestContentType)
if (trace.responseStatus < 400) {
parseContent(requestBodySpec, requestBody, requestContentType)
}
if (responseBody) {
if (!responses[responseStatusString]?.content) {
responses[responseStatusString] = {
Expand Down
5 changes: 3 additions & 2 deletions backend/src/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,13 @@ export const getRiskScore = (dataFields: DataField[]): RiskScore => {
if (!dataFields) {
return RiskScore.NONE
}
let numRiskySensitiveDataClasses = 0
let uniqueSensitiveDataClasses = new Set<string>()
for (const dataField of dataFields) {
if (dataField.dataClasses) {
numRiskySensitiveDataClasses += dataField.dataClasses?.length ?? 0
dataField.dataClasses.forEach(e => uniqueSensitiveDataClasses.add(e))
}
}
const numRiskySensitiveDataClasses = uniqueSensitiveDataClasses.size
switch (true) {
case numRiskySensitiveDataClasses >= 3:
return RiskScore.HIGH
Expand Down