history.push({pathname: path, query})}>
12 |
15 | )
16 | }
17 |
18 | export default BackRouteButton;
--------------------------------------------------------------------------------
/ui/src/components/NoResultsDisplay/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 |
4 | import noResultsImage from 'utils/images/empty.svg';
5 |
6 | import './no-results-display.scss';
7 |
8 | const NoResultsDisplay = ({title, isSmall=false}) => {
9 | return (
10 | {title}
14 |
11 | 
13 |
14 | )
15 | }
16 |
17 | export default NoResultsDisplay;
--------------------------------------------------------------------------------
/ui/src/components/MethodTag/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import Tag from 'components/Tag';
3 |
4 | import COLORS from 'utils/scss_variables.module.scss';
5 |
6 | const COLOR_MAPPING = {
7 | POST: COLORS["color-success"],
8 | GET: COLORS["color-main-light"],
9 | PUT: COLORS["color-warning"],
10 | PATCH: COLORS["color-status-blue"],
11 | OPTIONS: COLORS["color-main"],
12 | HEAD: COLORS["color-status-violet"],
13 | DELETE: COLORS["color-error"]
14 | }
15 |
16 | const MethodTag = ({method}) => (
17 | {title}
12 |
8 | 
11 |
12 | )
13 |
14 | export default MessageImageDisplay;
15 |
--------------------------------------------------------------------------------
/plugins/otel-collector/scripts/modify_otelcol_builder.awk:
--------------------------------------------------------------------------------
1 | #!/usr/bin/awk -f
2 | {
3 | if (/output_path/) {
4 | print " output_path: .";
5 | } else if (/exporters:/) {
6 | print $0, "\n",
7 | " - gomod: github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter v0.0.0";
8 | } else {
9 | print;
10 | }
11 | }
12 | END {
13 | print "\nreplaces:\n",
14 | " - github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter v0.0.0 => ./otel-collector/apiclarityexporter\n",
15 | " - github.com/openclarity/apiclarity/plugins/api v0.0.0 => ./api\n";
16 | }
--------------------------------------------------------------------------------
/charts/apiclarity/templates/traffic_sources/tap/clusterrolebinding.yaml:
--------------------------------------------------------------------------------
1 | {{- if and .Values.trafficSource.tap.enabled .Values.apiclarity.rbac.create }}
2 | apiVersion: rbac.authorization.k8s.io/v1
3 | kind: ClusterRoleBinding
4 | metadata:
5 | name: {{ include "apiclarity-taper.name" . }}
6 | labels:
7 | {{ include "apiclarity-taper.labels" . }}
8 | roleRef:
9 | apiGroup: rbac.authorization.k8s.io
10 | kind: ClusterRole
11 | name: {{ include "apiclarity-taper.name" . }}
12 | subjects:
13 | - kind: ServiceAccount
14 | name: {{ include "apiclarity-taper.name" . }}
15 | namespace: '{{ .Release.Namespace }}'
16 | {{- end }}
17 |
--------------------------------------------------------------------------------
/ui/src/components/TitleValueDisplay/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 |
4 | import './title-value-display.scss';
5 |
6 | export const TitleValueDisplayRow = ({children}) => (
7 | {message}
9 | {!!subMessage && {subMessage}
}
10 | {children}
8 | );
9 |
10 | const TitleValueDisplay = ({title, children, className}) => (
11 |
12 |
15 | );
16 |
17 | export default TitleValueDisplay
--------------------------------------------------------------------------------
/ui/src/components/Notification/notification.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .notification-wrapper {
4 | position: absolute;
5 | top: 0;
6 | left: 0;
7 | right: 0;
8 | background-color: $color-blue;
9 | color: $color-grey-black;
10 | height: 50px;
11 | font-size: 12px;
12 | line-height: 18px;
13 | display: flex;
14 | align-items: center;
15 | padding: 0 30px;
16 | filter: drop-shadow(0px 5px 10px rgba(34, 43, 54, 0.11));
17 |
18 | &.error {
19 | background-color: $color-error-light;
20 | }
21 | .notification-content {
22 | width: 100%;
23 | }
24 | }
--------------------------------------------------------------------------------
/plugins/Dockerfile.kong:
--------------------------------------------------------------------------------
1 | FROM golang:1.17.8-alpine3.14 AS builder
2 |
3 | ## Note: this Dockerfile will only be built from the plugins context
4 |
5 | RUN apk add --update --no-cache gcc g++
6 |
7 | WORKDIR /plugins
8 | COPY api ./api
9 |
10 | WORKDIR /plugins/common
11 |
12 | COPY common/go.* ./
13 | RUN go mod download
14 |
15 | COPY common ./
16 |
17 | WORKDIR /plugins/gateway/kong
18 | COPY gateway/kong/go.* ./
19 |
20 | RUN go mod download
21 |
22 | COPY gateway/kong .
23 |
24 | # Build the plugin.
25 | RUN go build -o bin/kong-plugin plugin.go
26 |
27 | FROM busybox
28 | COPY --from=builder ["/plugins/gateway/kong/bin/kong-plugin", "/kong-plugin"]
29 |
--------------------------------------------------------------------------------
/ui/src/components/Form/form-fields/YesNoToggleField/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import RadioField from '../RadioField';
4 |
5 | import './yes-no-toggle-field.scss';
6 |
7 | const YesNoToggleField = ({className, ...props}) => {
8 | return (
9 | {title}
13 | {children}
14 |
8 |
13 |
14 | );
15 |
16 | export default Checkbox;
17 |
--------------------------------------------------------------------------------
/backend/pkg/modules/assets/traceanalyzer/sensitive_rules/sensitive_rules_1.yaml:
--------------------------------------------------------------------------------
1 | - id: core-001
2 | description: "'password' keyword in flow data"
3 | regex: '(?i)password'
4 | searchIn: # Allowed values: RequestBody, ResponseBody, RequestHeaders, ResponseHeaders
5 | - RequestBody
6 | - ResponseBody
7 | - RequestHeaders
8 | - ResponseHeaders
9 |
10 | - id: core-002
11 | description: HTTP Headers contains information about backend
12 | regex: '(?i)x-powered-by'
13 | searchIn:
14 | - RequestHeaders
15 | - ResponseHeaders
16 |
17 | - id: core-003
18 | description: HTTP Headers contains information about running server
19 | regex: '(?i)server'
20 | searchIn:
21 | - RequestHeaders
22 | - ResponseHeaders
23 |
--------------------------------------------------------------------------------
/backend/pkg/modules/assets/bfla/BFLA_FSM.dot:
--------------------------------------------------------------------------------
1 | digraph BFLA_FSM {
2 |
3 | Start->Learning [label=startLearning, color=green]
4 | Learning->Learnt [label=stopLearning, color=red]
5 | Learning->Detecting[label=startDetection]
6 | Learning->Start[label=reset, color=red]
7 | Learnt->Start [label=reset]
8 | Learnt->Detecting [label=startDetection, color=green]
9 | Learnt->Learning [label=startLearning, color=green]
10 | Detecting->Learnt [label=stopDetection, color=red]
11 | Detecting->Start [label=reset, color=red]
12 | Detecting->Learning [label=startLearning]
13 | Learnt->Learnt[label=updateModel]
14 | Detecting->Detecting[label=updateModel]
15 |
16 | a [label="red=disable traces \n green=enable traces\nblack=no changes in tracing status", shape="box"]
17 | }
18 |
--------------------------------------------------------------------------------
/ui/src/components/DisplaySection/display-section.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .display-section-wrapper {
4 | .section-title-wrapper {
5 | margin: 20px 0;
6 | display: flex;
7 | align-items: center;
8 | justify-content: space-between;
9 | cursor: pointer;
10 |
11 | &.with-padding {
12 | padding: 20px 0;
13 | }
14 | &.with-close-toggle .section-title {
15 | color: $color-main;
16 | }
17 | &:not(.hide-underline) {
18 | border-bottom: 1px solid $color-grey-light;
19 | }
20 | .section-title {
21 | font-weight: 700;
22 | font-size: 12px;
23 | }
24 | }
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/ui/src/components/Arrow/arrow.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .arrow-icon {
4 | transition: transform .2s ease-in-out;
5 |
6 | &:not(.small) {
7 | &.right-arrow {
8 | transform: rotate(180deg);
9 | }
10 |
11 | &.bottom-arrow {
12 | transform: rotate(-90deg);
13 | }
14 |
15 | &.top-arrow {
16 | transform: rotate(90deg);
17 | }
18 | }
19 |
20 | &.small {
21 | &.right-arrow {
22 | transform: rotate(180deg);
23 | }
24 |
25 | &.bottom-arrow {
26 | transform: rotate(-90deg);
27 | }
28 |
29 | &.top-arrow {
30 | transform: rotate(90deg);
31 | }
32 | }
33 | }
--------------------------------------------------------------------------------
/ui/src/components/Form/form-fields/utils.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import InfoIcon from 'components/InfoIcon';
4 |
5 | export const FieldLabel = ({children, tooltipId, tooltipText, className}) => (
6 |
7 |
8 | {!!tooltipText &&
10 | );
11 |
12 | export const FieldDescription = ({children}) => (
13 | {children}
14 | );
15 |
16 | export const FieldError = ({children}) => (
17 | {children}
18 | )
--------------------------------------------------------------------------------
/ui/src/components/RoundIconContainer/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import Icon from 'components/Icon';
4 |
5 | import './round-icon-container.scss';
6 |
7 | const RoundIconContainer = ({name, onClick, className, small=false, disabled}) => {
8 | const containerClassName = classnames(
9 | "round-icon-container",
10 | {clickable: !!onClick},
11 | {[className]: className, small},
12 | {disabled: disabled}
13 | );
14 |
15 | return (
16 | disabled || !onClick ? undefined : onClick(event)}>
17 |
19 | );
20 | };
21 |
22 | export default RoundIconContainer;
23 |
--------------------------------------------------------------------------------
/ui/src/layout/Reviewer/utils.js:
--------------------------------------------------------------------------------
1 | export const SEPARATOR = "/";
2 |
3 | export const checkIsParam = section => section.startsWith("{") && section.endsWith("}");
4 |
5 | export const getPathWithParamInIndex = (path, index, paramName) => {
6 | const pathList = path.split(SEPARATOR);
7 |
8 | if (pathList.length <= index) {
9 | return path;
10 | }
11 |
12 | const updatedPathList = [
13 | ...pathList.slice(0, index),
14 | `{${paramName}}`,
15 | ...pathList.slice(index + 1)
16 | ];
17 |
18 | return updatedPathList.join(SEPARATOR);
19 | }
20 |
21 | export const getMethodsFromPaths = paths => (
22 | [...new Set(paths.reduce((acc, curr) => {
23 | return [...acc, ...curr.methods];
24 | }, []))]
25 | )
--------------------------------------------------------------------------------
/ui/src/components/DownloadJsonButton/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import { ICON_NAMES } from 'components/Icon';
3 | import IconWithTitle from 'components/IconWithTitle';
4 |
5 | const DownloadJsonButton = ({title, fileName, data}) => {
6 | const downloadFile = () => {
7 | const file = new Blob([JSON.stringify(data, null, 2)], {type: "text/plain"});
8 |
9 | const element = document.createElement("a");
10 | element.href = URL.createObjectURL(file);
11 | element.download = `${fileName}.json`;
12 | element.click();
13 | };
14 |
15 | return (
16 | !disabled && onClick ? onClick(event) : null}
15 | >
16 |
18 | );
19 | }
20 |
21 | export default IconWithTitle;
22 |
--------------------------------------------------------------------------------
/ui/src/components/ModalConfirmation/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import Modal from 'components/Modal';
4 | import Text, { TEXT_TYPES } from 'components/Text';
5 |
6 | import './modal-confirmation.scss';
7 |
8 | const ModalConfirmation = ({ title, message, confirmTitle, onCancle, onConfirm, loading, className }) => (
9 | {title}
17 |
6 |
11 | );
12 |
13 | export const ModalTitleDataItem = ({ title, className, children }) => (
14 | {title}
7 |
8 | {children}
9 |
10 |
15 |
20 | );
21 |
--------------------------------------------------------------------------------
/ui/src/components/SideDrawer/utils.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 |
4 | export const ModalSection = ({title, className, children}) => (
5 | {title}
16 |
17 | {children}
18 |
19 |
6 |
11 | );
12 |
13 | export const ModalTitleDataItem = ({title, className, children}) => (
14 | {title}
7 |
8 | {children}
9 |
10 |
15 |
20 | );
21 |
--------------------------------------------------------------------------------
/ui/src/components/TableSimple/table-simple.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .table-simple {
4 | width: 100%;
5 |
6 | &.no-border {
7 | thead {
8 | border: none;
9 | }
10 | tbody td {
11 | border: none;
12 | }
13 | }
14 | thead {
15 | font-weight: bold;
16 | font-size: 9px;
17 | text-transform: uppercase;
18 | color: $color-main;
19 | border-bottom: 1px solid $color-main;
20 |
21 | th {
22 | padding: 10px;
23 | }
24 | }
25 | tbody {
26 | font-size: 11px;
27 |
28 | td {
29 | border: 1px solid $color-grey-light;
30 | border-top: none;
31 | padding: 10px;
32 | }
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/ui/src/layout/Reviewer/MergeModal/merge-modal.scss:
--------------------------------------------------------------------------------
1 | .merge-modal {
2 | .select-wrapper {
3 | margin: 10px 0;
4 | max-height: 150px;
5 | overflow-y: auto;
6 |
7 | .checkbox-list-select-wrapper .ag-checkbox-wrapper .ag-checkbox {
8 | align-items: flex-start;
9 |
10 | .merge-review-path-display {
11 | .merge-review-path-display-path {
12 | display: inline-flex;
13 | flex-wrap: wrap;
14 | }
15 | .merge-review-path-display-methods {
16 | margin-top: 10px;
17 |
18 | .tag-wrapper {
19 | margin-right: 5px;
20 | }
21 | }
22 | }
23 | }
24 | }
25 | }
--------------------------------------------------------------------------------
/backend/pkg/common/trace_source.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package common
17 |
18 | const (
19 | DefaultTraceSourceID uint = 0
20 | )
21 |
--------------------------------------------------------------------------------
/charts/apiclarity/templates/NOTES.txt:
--------------------------------------------------------------------------------
1 | Thank you for installing {{ .Chart.Name | upper }}.
2 |
3 | Your release is named {{ .Release.Name }}.
4 |
5 | Here is how to access the APIClarity UI:
6 |
7 | $ kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ include "apiclarity.name" . }} 9999:8080
8 | $ Open APIClarity UI in the browser: http://localhost:9999/
9 | $ Generate some traffic in the applications in the traced namespaces and check the APIClarity UI :)
10 |
11 |
12 |
13 | {{- if .Values.trafficSource.tyk.enabled }}
14 |
15 |
16 | Note: Tyk traffic source is enabled.
17 | Follow the instructions in https://github.com/openclarity/apiclarity/tree/{{ .Chart.AppVersion }}/plugins/gateway/tyk to configure the Tyk API definitions to use the APIClarity plugin.
18 | {{- end }}
19 |
--------------------------------------------------------------------------------
/ui/src/components/VulnerabilityIcon/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import Icon, { ICON_NAMES } from 'components/Icon';
4 | import {SYSTEM_RISKS} from 'utils/utils';
5 |
6 | const VulnerabilityIcon = ({severity, onClick, showSuccess=true, showUnknown=false}) => {
7 | // const severityClass = severity.toLowerCase();
8 | const severityClass = severity.toUpperCase();
9 |
10 | return (
11 | {title}
16 |
17 | {children}
18 |
19 |
8 |
14 | )
15 |
16 | const KeyValueList = ({items}) => (
17 | {label}
9 |
10 |
13 | {!!value || value === 0 ? value : (hideEmpty ? "" : 'N/A')}
11 | {!!icon &&
18 | {items.map((item, index) =>
20 | );
21 |
22 | export default KeyValueList;
23 |
--------------------------------------------------------------------------------
/ui/src/components/Table/ColumnsSelectPanel/columns-select-panel.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .columns-select-panel-container {
4 | height: 100%;
5 | position: absolute;
6 | top: 0;
7 | right: 0;
8 | width: 230px;
9 | padding: 15px;
10 | background-color: $color-white;
11 | border: 1px solid $color-grey-lighter;
12 | overflow-y: scroll;
13 | z-index: 3;
14 |
15 | .header-columns-wrapper {
16 | .header-column-title {
17 | text-transform: uppercase;
18 | color: $color-main;
19 | margin-bottom: 10px;
20 | font-weight: bold;
21 | font-size: 9px;
22 | }
23 | .header-columns {
24 | margin-left: 30px;
25 | margin-bottom: 20px;
26 | }
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/plugins/gateway/tyk/v3.2.2/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/openclarity/apiclarity/plugins/gateway/tyk
2 |
3 | go 1.16
4 |
5 | // From here: https://tyk.io/docs/plugins/supported-languages/golang/#plugin-development-flow
6 | replace github.com/jensneuse/graphql-go-tools => github.com/TykTechnologies/graphql-go-tools v1.6.2-0.20211112130051-ad1e36a78a9a
7 |
8 | require (
9 | github.com/TykTechnologies/tyk v1.9.2-0.20211119141645-a642669fba58
10 | github.com/gin-gonic/gin v1.7.0 // indirect
11 | github.com/go-openapi/strfmt v0.21.0
12 | github.com/openclarity/apiclarity/plugins/api v0.0.0
13 | github.com/openclarity/apiclarity/plugins/common v0.0.0
14 | )
15 |
16 | replace github.com/openclarity/apiclarity/plugins/api v0.0.0 => ./../../../api
17 |
18 | replace github.com/openclarity/apiclarity/plugins/common v0.0.0 => ./../../../common
19 |
--------------------------------------------------------------------------------
/ui/src/components/DotLoader/dot-loader.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .dot-loader-wrapper {
4 | display: flex;
5 |
6 | .loader-dot {
7 | margin: 1px;
8 | width: 4px;
9 | height: 4px;
10 | border-radius: 50%;
11 | transform: scale(0.5);
12 | animation: scale-dot 1.2s ease-out infinite;
13 | &:nth-of-type(2) {
14 | animation-delay: 0.2s;
15 | }
16 | &:nth-of-type(3) {
17 | animation-delay: 0.3s;
18 | }
19 | }
20 | }
21 |
22 | @keyframes scale-dot {
23 | 0% {
24 | transform: scale(0.5);
25 | }
26 | 25% {
27 | transform: scale(1);
28 | }
29 | 75% {
30 | transform: scale(0.5);
31 | }
32 | 100% {
33 | transform: scale(0.5);
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/ui/src/components/IconWithTitle/icon-with-title.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .icon-container {
4 | display: inline-flex;
5 | align-items: center;
6 | padding: 5px;
7 | white-space: nowrap;
8 |
9 | .icon-title {
10 | float: left;
11 | margin-left: 5px;
12 | font-weight: bold;
13 | font-size: 10px;
14 | line-height: 22px;
15 | }
16 | .arrow-icon {
17 | margin: 0 5px 4px 10px;
18 | }
19 | &:not(.disabled) {
20 | .icon {
21 | color: $color-main;
22 | }
23 | }
24 | &.disabled {
25 | cursor: not-allowed;
26 |
27 | .icon,
28 | .icon-title {
29 | color: $color-grey;
30 | }
31 | }
32 | &.clickable {
33 | cursor: pointer;
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/ui/src/layout/Inventory/InventoryDetails/Specs/MethodHitCount/method-hit-count.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | .method-hit-count-wrapper {
4 | margin: 40px 30px 15px 30px;
5 |
6 | .hit-count-title {
7 | font-weight: bold;
8 | font-size: 14px;
9 | line-height: 14px;
10 | color: $color-main;
11 | padding: 15px 0;
12 | border-bottom: 1px solid $color-grey-light;
13 | }
14 | .hit-count-content {
15 | margin: 30px 0;
16 | position: relative;
17 |
18 | .time-filter-wrapper {
19 | position: absolute;
20 | top: 0;
21 | right: 0;
22 | }
23 | .hit-count-chart-wrapper {
24 | width: 100%;
25 | height: 300px;
26 | padding-top: 50px;
27 | }
28 | }
29 | }
--------------------------------------------------------------------------------
/ui/src/components/Form/form-fields/TextAreaField/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import { isEmpty } from 'lodash';
3 | import { Field } from 'formik';
4 | import { FieldLabel, FieldError } from '../utils';
5 |
6 | import './text-area-field.scss';
7 |
8 | const TextAreaField = ({name, label, tooltipText, placeholder, disabled, validate}) => (
9 |
13 | {!isEmpty(label) && {label} }
14 |
15 | {meta.touched && meta.error && {meta.error} }
16 |
17 | )
18 | }}
19 |
19 |
23 | )
24 | }
25 |
26 | export default RiskTag;
27 |
--------------------------------------------------------------------------------
/plugins/gateway/apigeex/sharedflowbundle.template/Apigee-APIClarity-Tracing.xml:
--------------------------------------------------------------------------------
1 |
2 |
20 | {label || ALERT_RISKS[formattedRisk].label}
21 |
22 |
9 |
15 | )
16 |
17 | export default TitleWithRiskDisplay;
18 |
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/traceanalyzer/utils/consts.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package utils
17 |
18 | const (
19 | ModuleName = "traceanalyzer"
20 | ModuleDescription = "Inspects request and responses to detect insecure practices"
21 | )
22 |
--------------------------------------------------------------------------------
/plugins/gateway/apigeex/sharedflowbundle.template/policies/JavaScript-APIClarity-Tracing.xml:
--------------------------------------------------------------------------------
1 |
2 | {title}
10 |
11 | {!!AlertDisplay &&
14 | {!!CustomRiskDisplay ?
}
13 | {children}
29 |
19 |
22 |
23 |
24 | )
25 | }
26 |
--------------------------------------------------------------------------------
/ui/src/modules/bfla/DataCollectionScreen/index.js:
--------------------------------------------------------------------------------
1 | import Button from 'components/Button'
2 | import React from 'react'
3 |
4 | import './data-collection-bfla.scss'
5 |
6 | const DATA_COLLECTION_SCREEN_TITLE = 'BFLA model learning'
7 | const DATA_COLLECTION_SCREEN_SUBTITLE = 'Sending and analysing traces uses cluster resources (network traffic, CPU consumtion, storage consumptions)'
8 |
9 | export default function DataCollectionScreen({ handleStartModelLearning }) {
10 | return (
11 |
12 |
24 | )
25 | }
26 |
--------------------------------------------------------------------------------
/api3/global/gen.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package global
17 |
18 | //go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -old-config-style -generate chi-server,client,types,spec,skip-prune -package global -o restapi.gen.go --import-mapping=../common/openapi.yaml:github.com/openclarity/apiclarity/api3/common openapi.gen.yaml
19 |
--------------------------------------------------------------------------------
/ui/src/components/InfoIcon/info-icon.scss:
--------------------------------------------------------------------------------
1 | @import 'utils/scss_variables.module.scss';
2 |
3 | $info-icon-wrap-size: 14px;
4 | $info-icon-size: 12px;
5 | $info-icon-margin: 5px;
6 |
7 | .round-icon-container.info-icon-container {
8 | width: $info-icon-wrap-size;
9 | height: $info-icon-wrap-size;
10 | min-width: $info-icon-wrap-size;
11 | min-height: $info-icon-wrap-size;
12 | background-color: $color-grey-light;
13 |
14 | &.info-icon-non-tooltip {
15 | margin-left: $info-icon-margin;
16 | }
17 | .icon {
18 | width: $info-icon-size;
19 | height: $info-icon-size;
20 | min-width: $info-icon-size;
21 | min-height: $info-icon-size;
22 | top: calc(50% - #{$info-icon-size} / 2);
23 | left: calc(50% - #{$info-icon-size} / 2);
24 | color: $color-grey-black;
25 | }
26 | }
27 | .info-icon-tooltip-wrapper {
28 | width: $info-icon-wrap-size;
29 | height: $info-icon-wrap-size;
30 | margin-left: $info-icon-margin;
31 | }
32 |
--------------------------------------------------------------------------------
/ui/src/components/LineLoader/LineLoader.stories.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import LineLoader from 'components/LineLoader';
3 |
4 | export default {
5 | title: 'LineLoader',
6 | component: LineLoader,
7 | argTypes: {
8 | displayItems: {
9 | control: {type: "boolean"}
10 | },
11 | displayPercent: {
12 | control: {type: "boolean"}
13 | },
14 | title: {
15 | control: {type: "text"}
16 | },
17 | done: {
18 | control: {type: "number"}
19 | },
20 | total: {
21 | control: {type: "number"}
22 | },
23 | className: {
24 | control: {type: "text"}
25 | }
26 | },
27 | args: {
28 | displayItems: true,
29 | displayPercent: true,
30 | title: "items",
31 | done: 15,
32 | total: 60
33 | }
34 | };
35 |
36 | const Template = (args) =>
13 | {DATA_COLLECTION_SCREEN_TITLE}
14 |
15 |
16 | {DATA_COLLECTION_SCREEN_SUBTITLE}
17 |
18 |
23 |
13 |
14 | {displayItems &&
17 | );
18 | }
19 |
20 | export default LineLoader;
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/bfla/restapi/gen.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package restapi
17 |
18 | //go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -old-config-style -generate chi-server,types,spec,skip-prune -package restapi -o restapi.gen.go --import-mapping=../../../../../../api3/common/openapi.yaml:github.com/openclarity/apiclarity/api3/common openapi.yaml
19 |
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/fuzzer/restapi/gen.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package restapi
17 |
18 | //go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -old-config-style -generate chi-server,types,spec,skip-prune -package restapi -o restapi.gen.go --import-mapping=../../../../../../api3/common/openapi.yaml:github.com/openclarity/apiclarity/api3/common openapi.yaml
19 |
--------------------------------------------------------------------------------
/plugins/Dockerfile.taper:
--------------------------------------------------------------------------------
1 | FROM golang:1.16.6-alpine AS builder
2 |
3 | # Set necessary environment variables needed for our image.
4 | ENV CGO_ENABLED=1 GOOS=linux GOARCH=amd64
5 |
6 | RUN apk add libpcap-dev gcc g++ make bash
7 |
8 | WORKDIR /plugins
9 |
10 | COPY api ./api
11 | COPY common ./common
12 |
13 | WORKDIR /plugins/taper
14 |
15 | COPY taper/go.* ./
16 | RUN go mod download
17 |
18 | ARG VERSION
19 | COPY taper .
20 | RUN go build -ldflags="-s -w \
21 | -X 'github.com/openclarity/apiclarity/plugins/taper/version.Version=${VERSION}'" -o agent .
22 |
23 | WORKDIR /plugins/taper/extensions/http
24 |
25 | COPY taper/extensions/http .
26 | RUN go build -buildmode=plugin -o ../http.so .
27 |
28 | FROM alpine:3.14
29 |
30 | RUN apk add bash libpcap-dev tcpdump
31 | WORKDIR /app
32 |
33 | # Copy binary and config files from /build to root folder of scratch container.
34 | COPY --from=builder ["/plugins/taper/agent", "."]
35 | COPY --from=builder ["/plugins/taper/extensions/http.so", "extensions/http.so"]
36 |
37 | ENTRYPOINT ["/app/agent"]
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/fuzzer/clients/constants.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package clients
17 |
18 | const (
19 | containerNamePrefix = "scn-fuzzer-"
20 | jobNamePrefix = "scn-fuzzer-"
21 |
22 | uriEnvVar = "URI"
23 | apiIDEnvVar = "API_ID"
24 | authEnvVar = "SERVICE_AUTH"
25 | restlerTimeBudgetEnvVar = "RESTLER_TIME_BUDGET"
26 | )
27 |
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/spec_differ/restapi/gen.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package restapi
17 |
18 | //go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -old-config-style -generate chi-server,types,spec,skip-prune -package restapi -o restapi.gen.go --import-mapping=../../../../../../api3/common/openapi.yaml:github.com/openclarity/apiclarity/api3/common openapi.yaml
19 |
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/traceanalyzer/restapi/gen.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package restapi
17 |
18 | //go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -old-config-style -generate chi-server,types,spec,skip-prune -package restapi -o restapi.gen.go --import-mapping=../../../../../../api3/common/openapi.yaml:github.com/openclarity/apiclarity/api3/common openapi.yaml
19 |
--------------------------------------------------------------------------------
/plugins/gateway/apigeex/sharedflowbundle.template/policies/Key-Value-Map-Operations-Update-APIClarity-Tracing.xml:
--------------------------------------------------------------------------------
1 |
2 | {`${done} of ${total} ${title}`}
}
15 | {displayPercent && {`${percent}%`}
}
16 |
12 |
22 | )
23 | }
24 |
25 | export default Accordion;
26 |
--------------------------------------------------------------------------------
/ui/src/layout/TraceSources/GeneralFilter.js:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import Filter, {
3 | OPERATORS,
4 | formatFiltersToQueryParams,
5 | } from "components/Filter";
6 | import { TRACES_TYPES } from "utils/utils";
7 |
8 | export { formatFiltersToQueryParams };
9 |
10 | const TYPE_ITEMS = Object.values(TRACES_TYPES);
11 |
12 | const FILTERS_MAP = {
13 | name: {
14 | value: "name",
15 | label: "API name",
16 | operators: [
17 | { ...OPERATORS.start },
18 | { ...OPERATORS.end },
19 | { ...OPERATORS.contains },
20 | ],
21 | },
22 | type: {
23 | value: "type",
24 | label: "Type",
25 | operators: [
26 | {
27 | ...OPERATORS.is,
28 | valueItems: TYPE_ITEMS,
29 | creatable: true,
30 | },
31 | {
32 | ...OPERATORS.isNot,
33 | valueItems: TYPE_ITEMS,
34 | creatable: true,
35 | },
36 | ],
37 | },
38 | };
39 |
40 | const GeneralFilter = (props) => setIsOpen(isOpen => !isOpen) : null}>
13 | {customTitle ? customTitle :
16 | {(isOpen && !isEmpty) &&
17 | {title}
}
14 | {!isEmpty &&
18 | {children}
19 |
20 | }
21 |
9 | {
10 | items.map(item => {
11 | const {disabled=false} = item;
12 | return (
13 |
25 | );
26 |
27 | export default ListDisplay;
28 |
--------------------------------------------------------------------------------
/ui/src/layout/Dashboard/index.js:
--------------------------------------------------------------------------------
1 | import React, { useState } from 'react';
2 | import MainTitleWithRefresh from 'components/MainTitleWithRefresh';
3 | import ApiUsage from './ApiUsage';
4 | import MostUsed from './MostUsed';
5 | import LatestSpec from './LatestSpec';
6 |
7 | import './dashboard.scss';
8 |
9 | const Dashboard = () => {
10 | const [refreshTimestamp, setRefreshTimestamp] = useState(Date());
11 | const doRefreshTimestamp = () => setRefreshTimestamp(Date());
12 |
13 | return (
14 | onSelect(item)}
17 | >
18 |
21 | );
22 | })
23 | }
24 |
17 |
23 |
18 |
21 |
17 | {loading ?
25 | )
26 | }
27 |
28 | export default EventsGraph;
--------------------------------------------------------------------------------
/ui/src/components/Form/form-fields/ToggleField/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import { useField } from 'formik';
4 | import ToggleButton from 'components/ToggleButton';
5 | import InfoIcon from 'components/InfoIcon';
6 |
7 | import './toggle-field.scss';
8 |
9 | const ToggleField = (props) => {
10 | const {label, className, disabled, tooltipText, width} = props;
11 | const [field, meta, helpers] = useField(props);
12 | const {name, value} = field;
13 | const {setValue} = helpers;
14 |
15 | return (
16 |
17 |
27 | )
28 | }
29 |
30 | export default ToggleField;
--------------------------------------------------------------------------------
/api3/notifications/gen.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2022 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package notifications
17 |
18 | //go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -old-config-style -generate chi-server,client,types,spec,skip-prune -package notifications -o restapi.gen.go --import-mapping=../global/openapi.gen.yaml:github.com/openclarity/apiclarity/api3/global,../common/openapi.yaml:github.com/openclarity/apiclarity/api3/common openapi.gen.yaml
19 |
--------------------------------------------------------------------------------
/ui/src/components/DisplaySection/index.js:
--------------------------------------------------------------------------------
1 | import React, { useState } from 'react';
2 | import classnames from 'classnames';
3 | import Arrow, { ARROW_NAMES } from 'components/Arrow';
4 |
5 | import './display-section.scss';
6 |
7 | const DisplaySection = ({className, title, children, hideUnderline, allowClose=false, initialIsClosed=true, noPadding=false}) => {
8 | const [isClosed, setIsClosed] = useState(initialIsClosed);
9 |
10 | return (
11 |
12 |
18 | )
19 | }
20 |
21 | export default DisplaySection;
22 |
--------------------------------------------------------------------------------
/plugins/gateway/apigeex/preparebundle.sh:
--------------------------------------------------------------------------------
1 |
2 | #!/bin/bash
3 |
4 | BUNDLE_FILE="ApiClarityFlowBundle.zip"
5 | BUNDLE_FOLDER="sharedflowbundle"
6 |
7 | if [ -f "${BUNDLE_FILE}" ]; then
8 | echo "${BUNDLE_FILE} exists. Remove or delete it and then run the script again"
9 | exit 1
10 | fi
11 |
12 | if [ -d "${BUNDLE_FOLDER}" ]; then
13 | echo "${BUNDLE_FOLDER} exists. Remove or delete it and then run the script again"
14 | exit 1
15 | fi
16 |
17 | if [ -z "${APICLARITY_URL}" ]; then
18 | echo "ERROR: APICLARITY_URL env variable not defined"
19 | exit 1
20 | fi
21 |
22 | if [ -z "${APICLARITY_APIGEEX_TOKEN}" ]; then
23 | echo "ERROR: APICLARITY_URL env variable not defined"
24 | exit 1
25 | fi
26 |
27 |
28 | cp -r sharedflowbundle.template ${BUNDLE_FOLDER}
29 | cat sharedflowbundle.template/policies/JavaScript-APIClarity-Tracing.xml | sed "s|{{APIClarityURL}}|${APICLARITY_URL}|g" | sed "s|{{APIClarityToken}}|${APICLARITY_APIGEEX_TOKEN}|g" > ${BUNDLE_FOLDER}/policies/JavaScript-APIClarity-Tracing.xml
30 | zip -r ${BUNDLE_FILE} sharedflowbundle
31 |
32 | rm -rf ${BUNDLE_FOLDER}
33 |
34 |
--------------------------------------------------------------------------------
/.goreleaser.yml:
--------------------------------------------------------------------------------
1 | before:
2 | hooks:
3 | - git submodule init wasm-filters
4 | - git submodule update wasm-filters
5 |
6 | builds:
7 | -
8 | dir: backend
9 | main: ./cmd/backend
10 | binary: backend
11 | env:
12 | - CGO_ENABLED=0
13 | goos:
14 | - linux
15 | goarch:
16 | - amd64
17 |
18 | archives:
19 | -
20 | name_template: "{{ .ProjectName }}_{{ .Version }}"
21 |
22 | # Additional files/template/globs we want to add to the archive.
23 | files:
24 | - LICENSE
25 | - README.md
26 | - wasm-filters/deploy.sh
27 | - wasm-filters/envoyFilter.yaml
28 | - wasm-filters/bin/release/http-trace-filter.wasm
29 | - plugins/gateway/kong/deploy/*
30 | - plugins/gateway/tyk/deploy/*
31 |
32 | checksum:
33 | name_template: 'checksums.txt'
34 |
35 | # Change the default artifacts folder
36 | dist: goreleaser_artifacts
37 |
38 | snapshot:
39 | name_template: "{{ incpatch .Version }}-next"
40 |
41 | changelog:
42 | sort: asc
43 | filters:
44 | exclude:
45 | - '^docs:'
46 | - '^test:'
47 | - '^workflow:'
48 |
--------------------------------------------------------------------------------
/backend/pkg/modules/internal/common/http_utils.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2021 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package common
17 |
18 | import (
19 | "encoding/json"
20 | "net/http"
21 |
22 | log "github.com/sirupsen/logrus"
23 | )
24 |
25 | func HTTPResponse(w http.ResponseWriter, code int, v interface{}) {
26 | w.WriteHeader(code)
27 | if err := json.NewEncoder(w).Encode(v); err != nil {
28 | log.Error(err)
29 | http.Error(w, err.Error(), code)
30 | return
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/ui/src/components/Icon/utils.js:
--------------------------------------------------------------------------------
1 | export const ICON_NAMES = {
2 | ADD: "add",
3 | COLUMNS: "columns",
4 | DASHBOARD: "dashboard",
5 | TRACE_SOURCE: "trace-source",
6 | INVENTORY: "inventory",
7 | EVENTS: "events",
8 | EXCLAMATION_MARK_ROUND: "exclamation-mark-round",
9 | X_MARK: "x-mark",
10 | CHECK_MARK: "check-mark",
11 | STROKE: "stroke",
12 | SORT: "sort",
13 | CHEVRON_RIGHT: "chevron-right",
14 | CHEVRON_RIGHT_DOUBLE: "chevron-right-double",
15 | ALERT: "alert",
16 | ALERT_ROUND: "alert-round",
17 | ARROW_LEFT: "arrow-left",
18 | START_TIME: "start-time",
19 | END_TIME: "end-time",
20 | FILTER: "filter",
21 | DOWNLOAD: "download",
22 | DOWNLOAD_JSON: "download-json",
23 | REFRESH: "refresh",
24 | TABLE: "table",
25 | GRAPH: "graph",
26 | UNMERGE: "unmerge",
27 | ZOMBIE: "zombie",
28 | SHADOW: "shadow",
29 | BEETLE_ROUND: "beetle-round",
30 | INFO: "info",
31 | SHIELD_CHECK: "shield-check",
32 | SHIELD_CROSS: "shield-cross",
33 | SMALL_ARROW_LEFT: "small-arrow-left",
34 | ERROR: 'error',
35 | }
36 |
--------------------------------------------------------------------------------
/api3/notifications/openapi.stub.yaml:
--------------------------------------------------------------------------------
1 | info:
2 | title: "Core OAPI for APIClarity Notification"
3 | version: "1.0"
4 | openapi: 3.0.2
5 | servers:
6 | - url: /
7 | paths:
8 | /notification/{apiID}:
9 | post:
10 | summary: 'Provide to Apiclarity list of raw input for a given API ID associated with a given timestamp'
11 | parameters:
12 | - name: apiID
13 | in: path
14 | required: true
15 | schema:
16 | type: integer
17 | format: int64
18 | requestBody:
19 | description: 'Notification'
20 | required: true
21 | content:
22 | application/json:
23 | schema:
24 | $ref: '#/components/schemas/APIClarityNotification'
25 | responses:
26 | '200':
27 | description: 'Success'
28 | content:
29 | application/json:
30 | schema:
31 | type: string
32 |
33 | components:
34 | schemas:
35 | APIClarityNotification:
36 | oneOf: []
37 | discriminator:
38 | propertyName: notificationType
39 | mapping: {}
--------------------------------------------------------------------------------
/backend/pkg/modules/README.md:
--------------------------------------------------------------------------------
1 | ### Create a new module
2 |
3 | 1. Create a new module create a go package under `backend/pkg/modules/internal`
4 | 2. Implement the `backend/pkg/modules/internal/core.Module` interface
5 | 3. Create an init function and call the `core.RegisterModule` function that should do the initialization stems and return the module
6 | 4. Create a `openapi.yaml` for the http handlers and generate the code using oapi-codegen
7 | 1. Tip: create a `gen.go` file and add a `//go:generate` annotation for generating the server easier
8 | 5. Add the import to the new module with underscore. Eg: `_ "github.com/openclarity/apiclarity/backend/pkg/modules/internal/demo"`
9 |
10 | ### Create alerts
11 | Alerts are a way to annotate an event to signal that it has issues.
12 | The alerts can be of 2 types: `ALERT_INFO` and `ALERT_WARN`
13 |
14 | The alerts are just annotations and should be treated as such
15 | the core has the predefined alerts `core.AlertInfoAnn` and `core.AlertWarnAnn`
16 |
17 | Example setting Alerts:
18 | ```go
19 | accessor.CreateAPIEventAnnotations(ctx, "module_name", 1, core.AlertInfoAnn)
20 | ```
--------------------------------------------------------------------------------
/ui/src/layout/Dashboard/LatestSpec.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import PageContainer from 'components/PageContainer';
3 | import Title from 'components/Title';
4 | import SpecDiffIcon from 'components/SpecDiffIcon';
5 | import { formatDateBy } from 'utils/utils';
6 | import ApisList from './ApisList';
7 |
8 | const LatestSpec = ({refreshTimestamp}) => (
9 | setIsClosed(!isClosed)} className={classnames("section-title-wrapper", {"hide-underline": hideUnderline}, {"with-close-toggle": allowClose}, {"with-padding": !noPadding})}>
13 |
16 | {(!isClosed || !allowClose) && {title}
14 | {allowClose && {children}
}
17 | {formatDateBy(time, "MMM Do, HH:mm")}
}
19 | ]}
20 | />
21 |
18 | {!isEmpty(label) && {label} }
19 | {meta.error} }
23 |
24 | )
25 | }
26 |
27 | export default FormTimeField;
--------------------------------------------------------------------------------
/ui/src/layout/Events/EventDetails/SpecDiff.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import ReactDiffViewer from 'react-diff-viewer-continued';
3 | import { useFetch } from 'hooks';
4 | import Loader from 'components/Loader';
5 |
6 | const SpecDiff = ({url}) => {
7 | const [{loading, data}] = useFetch(url);
8 |
9 | const {newSpec, oldSpec} = data || {};
10 |
11 | return (
12 |
20 | setValue(value)} />
21 |
22 | {meta.touched && meta.error &&
13 | {loading ?
15 |
26 | }
27 |
28 | )
29 | }
30 |
31 | export default SpecDiff;
32 |
--------------------------------------------------------------------------------
/ui/src/modules/bfla/StartDetectionResumeLearningScreen/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import MessageImageDisplay from 'layout/Inventory/InventoryDetails/MessageImageDisplay'
3 | import MessageTextButton from 'components/MessageTextButton'
4 | import emptySelectImage from 'utils/images/empty_select_image.svg'
5 |
6 | export default function StartDetectionResumeLearningScreen({ handleStartDetection, handleStartLearning }) {
7 | return (
8 |
16 | {!newSpec && !oldSpec ?
17 |
19 |
22 | }
23 |
24 | No Spec Available
:
18 | Documented
20 | Detected
21 | 13 |
22 |
24 |
34 |
,
37 | portalContainer
38 | );
39 | }
40 |
41 | export default Notification;
--------------------------------------------------------------------------------
/ui/src/modules/bfla/NoSpecsScreen/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import { useHistory } from 'react-router-dom';
3 | import MessageImageDisplay from 'layout/Inventory/InventoryDetails/MessageImageDisplay'
4 | import MessageTextButton from 'components/MessageTextButton'
5 | import emptySelectImage from 'utils/images/empty_select_image.svg'
6 |
7 | export default function NoSpecScreen({ id }) {
8 | const history = useHistory();
9 |
10 | return (
11 | {message}
35 | 24 | enable BFLA detection for this API 25 | } 26 | image={emptySelectImage} 27 | /> 28 | ) 29 | } 30 | -------------------------------------------------------------------------------- /ui/src/components/Form/form-fields/RadioField/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import classnames from 'classnames'; 3 | import { isEmpty } from 'lodash'; 4 | import { useField } from 'formik'; 5 | import RadioButtons from 'components/RadioButtons'; 6 | import { FieldLabel, FieldError } from '../utils'; 7 | 8 | const RadioField = (props) => { 9 | const {items, label, className, tooltipText, horizontal=false, disabled=false} = props; 10 | const [field, meta, helpers] = useField(props); 11 | const {name, value} = field; 12 | const {setValue} = helpers; 13 | 14 | return ( 15 |
16 | {!isEmpty(label) && {label} }
17 | setValue(value)}
22 | horizontal={horizontal}
23 | disabled={disabled}
24 | />
25 | {meta.touched && meta.error && {meta.error} }
26 |
27 | )
28 | }
29 |
30 | export default RadioField;
--------------------------------------------------------------------------------
/backend/pkg/modules/utils/jsonpointer.go:
--------------------------------------------------------------------------------
1 | // Copyright © 2021 Cisco Systems, Inc. and its affiliates.
2 | // All rights reserved.
3 | //
4 | // Licensed under the Apache License, Version 2.0 (the "License");
5 | // you may not use this file except in compliance with the License.
6 | // You may obtain a copy of the License at
7 | //
8 | // http://www.apache.org/licenses/LICENSE-2.0
9 | //
10 | // Unless required by applicable law or agreed to in writing, software
11 | // distributed under the License is distributed on an "AS IS" BASIS,
12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | // See the License for the specific language governing permissions and
14 | // limitations under the License.
15 |
16 | package utils
17 |
18 | import (
19 | "strings"
20 |
21 | "github.com/go-openapi/jsonpointer"
22 | )
23 |
24 | func JSONPointer(tokens ...string) string {
25 | escapedTokens := []string{}
26 | for _, token := range tokens {
27 | if token == "" { // stop concatenation of token as soon as a token is empty
28 | break
29 | }
30 | escapedTokens = append(escapedTokens, jsonpointer.Escape(token))
31 | }
32 |
33 | if len(escapedTokens) == 0 {
34 | return ""
35 | }
36 |
37 | return "/" + strings.Join(escapedTokens, "/")
38 | }
39 |
--------------------------------------------------------------------------------
/ui/src/components/TabbedPageContainer/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import { Route, NavLink } from 'react-router-dom';
4 | import PageContainer from 'components/PageContainer';
5 |
6 | import './tabbed-page-container.scss';
7 |
8 | const TabbedPageContainer = ({items, noContentMargin}) => (
9 |
11 | {
12 | items.map(({title, to, linkTo, exact, disabled}, index) => {
13 | const TabTag = disabled ? "div" : NavLink;
14 |
15 | return (
16 |
17 |
19 | )
20 | })
21 | }
22 |
23 | {title}
18 |
24 | {
25 | items.map(({title, to, exact, component}, index) =>
28 |
18 | {!isEmpty(label) && {label} }
19 | setValue(event.target.checked)}
25 | disabled={disabled}
26 | />
27 | {meta.touched && meta.error && {meta.error} }
28 |
29 | )
30 | }
31 |
32 | export default CheckboxField;
--------------------------------------------------------------------------------
/ui/src/components/JsonDisplayBox/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 |
3 | //Transforms text with format: "___LINK___Displayed Text___HREF___url___LINK___" into a tag links
4 |
5 | const LINK_MARK = "___LINK___";
6 | const HREF_MARK = "___HREF___";
7 | const FORMATTING_PLACEHOLDER = "___LINKPLACEHOLDER___";
8 |
9 | const TextWithLinks = ({text}) => {
10 | let placeholderText = text;
11 |
12 | const replaceTextArrays = [...text.matchAll(LINK_MARK + "(.*?)" + LINK_MARK)];
13 |
14 | const linksInText = replaceTextArrays.map(([fullLinkText, innerLinkText]) => {
15 | placeholderText = placeholderText.replace(fullLinkText, FORMATTING_PLACEHOLDER);
16 |
17 | return innerLinkText;
18 | });
19 |
20 | return (
21 | placeholderText.split(FORMATTING_PLACEHOLDER).map((textItem, index) => {
22 | const linksInTextItem = linksInText[index];
23 |
24 | if (!linksInTextItem) {
25 | return textItem;
26 | }
27 |
28 | const [displayText, url] = linksInTextItem.split(HREF_MARK);
29 |
30 | return (
31 | {textItem}{displayText}
32 | );
33 | })
34 | )
35 | }
36 |
37 | export default TextWithLinks;
38 |
--------------------------------------------------------------------------------
/ui/src/components/TableSimple/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import classnames from 'classnames';
3 | import { isEmpty } from 'lodash';
4 |
5 | import './table-simple.scss';
6 |
7 | const TableSimple = ({ headers, rows, className, emptyText = "No data", hideBorder = false }) => {
8 | return (
9 | | {header} | ) 15 | } 16 |
|---|
| {cell} | ) 25 | } 26 |
| {emptyText} |