Skip to content
This repository was archived by the owner on Oct 11, 2024. It is now read-only.

Add security policies for Tyk OSS#536

Merged
singhpr merged 55 commits intomasterfrom
TT-3677/security-policies
Jan 9, 2023
Merged

Add security policies for Tyk OSS#536
singhpr merged 55 commits intomasterfrom
TT-3677/security-policies

Conversation

@buraksekili
Copy link

@buraksekili buraksekili commented Nov 25, 2022 •
edited
Loading

Description

This PR adds support for Security Policies API in CE mode. This API was introduced in Tyk GW version 4.1.
With this change, users will be able to manage Policy objects in CE mode.

Related Issue

Resolves #357
https://tyktech.atlassian.net/browse/TT-3677

Motivation and Context

Test Coverage For This Change

  1. Deploy CE testing environment
make boot-ce IMG=tykio/tyk-operator:test
  1. Create an ApiDefinition CR
kubectl apply -f ./config/samples/httpbin_protected.yaml
  1. Create a SecurityPolicy that will access ApiDefinition created above
kubectl apply -f ./config/samples/httpbin_protected_policy.yaml
  1. Do CRUD operations on Security Policy and verify corresponding changes on resources.

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • Make sure you are requesting to pull a topic/feature/bugfix branch (right side). If PRing from your fork, don't come from your master!
  • Make sure you are making a pull request against our master branch (left side). Also, it would be best if you started your change off our latest master.
  • Make sure you are updating CHANGELOG.md based on your changes.
  • My change requires a change to the documentation.
    • If you've changed APIs, describe what needs to be updated in the documentation.
  • I have updated the documentation accordingly.
  • If you've changed API models, please update CRDs.
    • make manifests
    • make helm
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • Check your code additions will not fail linting checks:
    • gofmt -s -w .
    • go vet ./...
    • golangci-lint run

@buraksekili
Add security policies for tyk oss
7794797 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update integration tests
096072c 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Add control over gw version for security policy tests
1cd269e 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Add if check to understand the existence of mongo id
f12f314 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update CHANGELOG
3fedc45 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update current CR based on existing policy
5bf6242 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update create method of SecurityPolicy Reconciler. So that, from now on
fe0bc57 
it will return SecurityPolicy spec.

Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Merge branch 'master' of github.com:TykTechnologies/tyk-operator into…
880fd6c 
… TT-3695/fix-policy-migration
@buraksekili
use CR's AccessRightsArray field instead of generating it
aab517d 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Merge branch 'master' of github.com:TykTechnologies/tyk-operator into…
c6cd1cd 
… TT-3695/fix-policy-migration
@buraksekili
Merge branch 'TT-3695/fix-policy-migration' of github.com:TykTechnolo…
f59cbef 
…gies/tyk-operator into TT-3695/fix-policy-migration
@buraksekili
add initial e2e tests for securitypolicy controller
ca890f6 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
fix linter issue, add additional error checks for type assertions
2d561be 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@caroltyk caroltyk added this to the v0.13.0 milestone Dec 6, 2022
@caroltyk
Copy link
Collaborator

caroltyk commented Dec 6, 2022

fix #357

@buraksekili
Merge branch 'master' into TT-3677/security-policies
278442e
@buraksekili
Add a logic to recover from unintended deletes from Dashboard for Sec…
0364786 
…urityPolicy. Add new e2e tests cases for migration

Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Fix issues on v3.2
df4c464 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
generate random name for securitypolicy
20bb248 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Wait for resource is updated properly
417b600 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Add new test cases to cover different scenarios of SecurityPolicy
3c3f9fe 
Controller.

Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
remove integration tests
b19d832 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Merge branch 'master' into TT-3695/fix-policy-migration
5a3eace
@buraksekili
Merge upstream
7464ef4 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Revert changes and update tests accordingly
eb25a07 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Merge branch 'TT-3695/fix-policy-migration' of github.com:TykTechnolo…
97cf594 
…gies/tyk-operator into TT-3695/fix-policy-migration
@buraksekili
Fix linter issue - remove extra new line
4d591f3 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Use unused StatusID in comparison function. Replace duplicated compar…
d17880a 
…ison with already-defined function. Compare previous and new ID after restoring from drifts. Remove redundant conditions in wait.For() function

Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update tests cases to prevent direct comparison between IDs
ce898b1 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
remove parsepolicy function to decide policy. Instead, use API respon…
4a81adc 
…se to decide new Policy ID

Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Merge branch 'master' into TT-3677/security-policies
58ec289
@buraksekili
Wait for until resources are created on Tyk
1b8ebe5 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Change comparison value for ID
ed2fbaf 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Merge branch 'master' into TT-3677/security-policies
2f8f8f2
@buraksekili
Add CHANGELOG entry for new changes
7aefc2c 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update Policy documentation
0001d55 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Run tests against Tyk v4.2
c41fb96 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Skip CE tests for Security Policies if the version is lower than 4.1
ec7b3d7 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Fix version check in integration tests
022ed84 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update default Tyk version in e2e tests
52e52ab 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update log statement in e2e test
899a94d 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Update reconciler logic
88fc790 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Fix invalid assignment of TYK_VERSION env variable in CE mode.
1433f78 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
Randomize policy names in e2e tests
64abd91 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
control test flow
7741976 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
komalsukhani
komalsukhani reviewed Dec 26, 2022
View reviewed changes
komalsukhani
komalsukhani reviewed Dec 26, 2022
View reviewed changes
komalsukhani
komalsukhani reviewed Dec 26, 2022
View reviewed changes
@buraksekili
Rename variable according to feedback
c082564 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@buraksekili
remove additional reconciliation
b17f597 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
komalsukhani
komalsukhani reviewed Dec 28, 2022
View reviewed changes
komalsukhani
komalsukhani reviewed Dec 28, 2022
View reviewed changes
@buraksekili
Remove redundant retries in e2e tests to verify Api updates
6c8a942 
Signed-off-by: Burak Sekili <buraksekili@gmail.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 6, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

0.0% 0.0% Coverage
0.0% 0.0% Duplication

@singhpr singhpr merged commit 3852b26 into master Jan 9, 2023
@singhpr singhpr deleted the TT-3677/security-policies branch January 9, 2023 05:32
buger pushed a commit that referenced this pull request May 22, 2024
@buraksekili
Add security policies for Tyk OSS (#536)
4154d90 
* Add security policies for tyk oss

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update integration tests

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Add control over gw version for security policy tests

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Add if check to understand the existence of mongo id

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update CHANGELOG

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update current CR based on existing policy

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update create method of SecurityPolicy Reconciler. So that, from now on
it will return SecurityPolicy spec.

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* use CR's AccessRightsArray field instead of generating it

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* add initial e2e tests for securitypolicy controller

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* fix linter issue, add additional error checks for type assertions

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Add a logic to recover from unintended deletes from Dashboard for SecurityPolicy. Add new e2e tests cases for migration

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Fix issues on v3.2

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* generate random name for securitypolicy

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Wait for resource is updated properly

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Add new test cases to cover different scenarios of SecurityPolicy
Controller.

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* remove integration tests

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Merge upstream

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Revert changes and update tests accordingly

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Fix linter issue - remove extra new line

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Use unused StatusID in comparison function. Replace duplicated comparison with already-defined function. Compare previous and new ID after restoring from drifts. Remove redundant conditions in wait.For() function

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update tests cases to prevent direct comparison between IDs

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* remove parsepolicy function to decide policy. Instead, use API response to decide new Policy ID

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Remove redundant white space

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update tests for CE

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Rename helper functions

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Wait for until resources are created on Tyk

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Change comparison value for ID

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Add CHANGELOG entry for new changes

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update Policy documentation

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Run tests against Tyk v4.2

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Skip CE tests for Security Policies if the version is lower than 4.1

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Fix version check in integration tests

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update default Tyk version in e2e tests

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update log statement in e2e test

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Update reconciler logic

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Fix invalid assignment of TYK_VERSION env variable in CE mode.

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Randomize policy names in e2e tests

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* control test flow

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Rename variable according to feedback

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* remove additional reconciliation

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

* Remove redundant retries in e2e tests to  verify Api updates

Signed-off-by: Burak Sekili <buraksekili@gmail.com>

Signed-off-by: Burak Sekili <buraksekili@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@komalsukhani komalsukhani komalsukhani approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v0.13.0

Development

Successfully merging this pull request may close these issues.

[TT-3677] Security Policies not implemented

4 participants

@buraksekili @caroltyk @komalsukhani @singhpr