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

UI - API-KEY authentication support for web socket APIs #498

Merged
merged 4 commits into from
Feb 1, 2024
Merged

UI - API-KEY authentication support for web socket APIs #498

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
f6fe8ce
Initial commit
thisaltennakoon Sep 14, 2023
bd4bcad
Update RuntimeConfigurationWebSocket.jsx
thisaltennakoon Jan 2, 2024
52ec07a
Merge branch 'wso2:main' into main
thisaltennakoon Jan 12, 2024
a8daae1
Merge branch 'wso2:main' into main
thisaltennakoon Jan 31, 2024
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
4 changes: 2 additions & 2 deletions ...tal/src/main/webapp/source/src/app/components/Apis/Details/AsyncApiConsole/AsyncApiUI.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,13 @@ export default function AsyncApiUI(props) {
function generateWSSubscriptionCommand(topic) {
const token = generateAccessToken();
if (topic.name.includes('*')) {
let wscat = `wscat -c '${endPoint}' -H 'Authorization: ${token}'`;
let wscat = `wscat -c '${endPoint}' -H '${securitySchemeType === 'API-KEY' ? 'apikey' : 'Authorization'}: ${token}'`;
if (isAdvertised && authorizationHeader !== '') {
wscat = `wscat -c '${endPoint}' -H '${authorizationHeader}: ${token}'`;
}
return wscat;
} else {
let wscat = `wscat -c '${endPoint}/${getTopicName(topic)}' -H 'Authorization: ${token}'`;
let wscat = `wscat -c '${endPoint}/${getTopicName(topic)}' -H '${securitySchemeType === 'API-KEY' ? 'apikey': 'Authorization'}: ${token}'`;
if (isAdvertised && authorizationHeader !== '') {
wscat = `wscat -c '${endPoint}/${getTopicName(topic)}' -H '${authorizationHeader}: ${token}'`;
}
Expand Down
118 changes: 97 additions & 21 deletions ...pp/source/src/app/components/Apis/Details/Configuration/RuntimeConfigurationWebSocket.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ import Paper from '@material-ui/core/Paper';
import { Link, useHistory } from 'react-router-dom';
import Box from '@material-ui/core/Box';
import Button from '@material-ui/core/Button';
import FormGroup from '@material-ui/core/FormGroup';
import ExpansionPanelDetails from '@material-ui/core/ExpansionPanelDetails';
import ExpandMoreIcon from '@material-ui/icons/ExpandMore';
import ExpansionPanelSummary from '@material-ui/core/ExpansionPanelSummary';
import WrappedExpansionPanel from 'AppComponents/Shared/WrappedExpansionPanel';
import Checkbox from '@material-ui/core/Checkbox';
import FormControlLabel from '@material-ui/core/FormControlLabel';
import { FormattedMessage } from 'react-intl';
import Alert from 'AppComponents/Shared/Alert';
import ArrowForwardIcon from '@material-ui/icons/SettingsEthernet';
Expand All @@ -34,6 +41,10 @@ import API from 'AppData/api';
import Endpoints from './components/Endpoints';
import KeyManager from './components/KeyManager';
import APILevelRateLimitingPolicies from './components/APILevelRateLimitingPolicies';
import {
DEFAULT_API_SECURITY_OAUTH2,
API_SECURITY_API_KEY
} from './components/APISecurity/components/apiSecurityConstants';

const useStyles = makeStyles((theme) => ({
root: {
Expand Down Expand Up @@ -95,6 +106,9 @@ const useStyles = makeStyles((theme) => ({
display: 'flex',
height: '100%',
},
error: {
color: theme.palette.error.main,
}
}));

/**
Expand Down Expand Up @@ -177,6 +191,13 @@ export default function RuntimeConfiguration() {
nextState.keyManagers = ['all'];
}
return nextState;
case 'securityScheme':
if (value.checked) {
nextState.securityScheme = [...nextState.securityScheme, value.value];
} else {
nextState.securityScheme = nextState.securityScheme.filter((item) => item !== value.value);
}
return nextState;
default:
return state;
}
Expand All @@ -187,6 +208,23 @@ export default function RuntimeConfiguration() {
const [apiConfig, configDispatcher] = useReducer(configReducer, copyAPIConfig(api));
const classes = useStyles();

const Validate = () => {

if (!apiConfig.securityScheme.includes(DEFAULT_API_SECURITY_OAUTH2)
&& !apiConfig.securityScheme.includes(API_SECURITY_API_KEY)
) {
return (
<Typography className={classes.bottomSpace}>
<FormattedMessage
id='Apis.Details.Configuration.components.APISecurity.emptySchemas'
defaultMessage='Please select at least one API security method.'
/>
</Typography>
);
}
return null;
};

/**
*
* Handle the configuration view save button action
Expand Down Expand Up @@ -232,27 +270,65 @@ export default function RuntimeConfiguration() {
<div className={classes.contentWrapper}>
<Grid container direction='row' justify='space-around' alignItems='stretch' spacing={8}>
<Grid item xs={12} md={7} style={{ marginBottom: 30, position: 'relative' }}>
<Typography className={classes.heading} variant='h6'>
<FormattedMessage
id='Apis.Details.Configuration.RuntimeConfigurationWebSocket.section.client.websocket'
defaultMessage='Client Websocket'
/>
</Typography>
<div className={classes.boxFlex}>
<Paper
className={classes.paper}
elevation={0}
style={{ display: 'flex', alignItems: 'center' }}
>
<Box pr={3}>
<KeyManager api={apiConfig} configDispatcher={configDispatcher} />
</Box>
<Box pr={3}>
<APILevelRateLimitingPolicies api={apiConfig} configDispatcher={configDispatcher} />
</Box>
</Paper>
<ArrowForwardIcon className={classes.arrowForwardIcon} />
</div>
<WrappedExpansionPanel className={classes.expansionPanel} id='applicationLevel'>
<ExpansionPanelSummary expandIcon={<ExpandMoreIcon />}>
<Typography className={classes.subHeading} variant='h6' component='h4'>
<FormattedMessage
id='Apis.Details.Configuration.Components.APISecurity.Components.
ApplicationLevel.Client.Websocket'
defaultMessage='Client Websocket'
/>
</Typography>
</ExpansionPanelSummary>
<ExpansionPanelDetails className={classes.expansionPanelDetails}>
<Typography className={classes.subHeading} variant='h6' component='h4'>
<FormattedMessage
id='Apis.Details.Configuration.Components.APISecurity.Components.
ApplicationLevel.Websocket'
defaultMessage='Application Level Security'
/>
</Typography>
<FormGroup style={{ display: 'flow-root' }}>
<FormControlLabel
control={(
<Checkbox
disabled={isRestricted(['apim:api_create'], apiConfig)}
checked={apiConfig.securityScheme.includes(DEFAULT_API_SECURITY_OAUTH2)}
onChange={({ target: { checked, value } }) => configDispatcher({
action: 'securityScheme',
value: { checked, value },
})}
value={DEFAULT_API_SECURITY_OAUTH2}
color='primary'
/>
)}
label='OAuth2'
/>
<FormControlLabel
control={(
<Checkbox
checked={apiConfig.securityScheme.includes(API_SECURITY_API_KEY)}
disabled={isRestricted(['apim:api_create'], apiConfig)}
onChange={({ target: { checked, value } }) => configDispatcher({
action: 'securityScheme',
value: { checked, value },
})}
value={API_SECURITY_API_KEY}
color='primary'
id='api-security-api-key-checkbox'
/>
)}
label='Api Key'
/>
</FormGroup>
<KeyManager api={apiConfig} configDispatcher={configDispatcher} />
<span className={classes.error}>
<Validate />
</span>
</ExpansionPanelDetails>
</WrappedExpansionPanel>
<APILevelRateLimitingPolicies api={apiConfig} configDispatcher={configDispatcher} />
<ArrowForwardIcon className={classes.arrowForwardIcon} />
</Grid>
<Grid item xs={12} md={4}>
<Typography className={classes.heading} variant='h6'>
Expand Down
Loading