|
| 1 | +--- |
| 2 | +title: "⚠️ Assets and Organizations (Pro)" |
| 3 | +description: "DefectDojo Pro - Product Hierarchy Overhaul" |
| 4 | +--- |
| 5 | + |
| 6 | +DefectDojo Pro is extending the Product/Product Type object classes to provide greater flexibility with the data model. |
| 7 | + |
| 8 | +Currently, this feature is in Beta. Pro users who are interested in opting in can do so by emailing [support@defectdojo.com](mailto:support@defectdojo.com). |
| 9 | + |
| 10 | +## Significant Changes |
| 11 | + |
| 12 | +* **Product Types** have been renamed to "Organizations", and **Products** have been renamed to "Assets". Currently, this name change is opt-in for existing DefectDojo Pro subscriptions. |
| 13 | +* **Assets** can now have parent/child relationships with one another to further sub-categorize Organizational components. |
| 14 | + |
| 15 | +### Organizations |
| 16 | + |
| 17 | +As with Product Types, **Organizations** should be understood as a top-level category. You can use these to separate your business' core software applications, departments or business functions. |
| 18 | + |
| 19 | +For example, you could create an Organization for many repository groupings: "Core Application", "Infrastructure", "DevOps", "Analytics", "SDK" could all contain multiple code repos. |
| 20 | + |
| 21 | +Keep in mind that for reporting purposes, it’s easier to combine multiple Organizations into a single document than it is to subdivide a single Organization into separate documents. Therefore, we recommend setting up Organizations at as granular a level as makes sense for your team's reports. For example, there is no need to represent a large business division as an Organization if you're primarily going to be reporting on individual departments within that division. |
| 22 | + |
| 23 | +### Assets |
| 24 | + |
| 25 | +Assets are meant to represent subdivisions of your Organizations. However, unlike Products, Assets can be nested, and have parent-child relationships with one another. |
| 26 | + |
| 27 | +## Asset Nesting Examples |
| 28 | + |
| 29 | +### Asset-Level Branch Representation |
| 30 | + |
| 31 | +Development and feature branches can be represented in a variety of ways; separate Engagements or Tests are existing ways that you can represent the difference between your Production, Dev, and other feature branches. |
| 32 | + |
| 33 | +You can also represent these using nested Assets. Consider the following Asset tree: |
| 34 | + |
| 35 | +``` |
| 36 | +Core Application [Organization] |
| 37 | +└── webapp-frontend |
| 38 | + ├── webapp-frontend/prod |
| 39 | + └── webapp-frontend/dev |
| 40 | + ├── webapp-frontend/dev/feature-a |
| 41 | + └── webapp-frontend/dev/feature-b |
| 42 | +``` |
| 43 | + |
| 44 | +In this environment, each branch (`prod`, `dev`, `feature a`, `feature b`) could have its own Engagements and Tests that are isolated from the other Assets, so that they don't deduplicate against each other. This setup can also ease in navigation, as Asset names can directly correspond to the path on Git. |
| 45 | + |
| 46 | +### Mono-Repo: Separate Components |
| 47 | + |
| 48 | +If you use a single repository for all of your code, but have different teams contributing to directories within that repository, you can set up your Asset nesting to represent that structure. |
| 49 | + |
| 50 | +``` |
| 51 | +Core Application [Organization] |
| 52 | +├── webapp-frontend [Parent Asset] |
| 53 | +│ ├── mobile-ios |
| 54 | +│ ├── mobile-android |
| 55 | +│ └── mobile-sdk |
| 56 | +├── webapp-backend [Parent Asset] |
| 57 | +│ ├── database |
| 58 | +│ └── api |
| 59 | +└── infra [Parent Asset] |
| 60 | + ├── docker |
| 61 | + ├── kubernetes |
| 62 | + └── nginx |
| 63 | +``` |
| 64 | + |
| 65 | +In this diagram, every element under "Core Application" could be recorded as a separate Asset, with unique business criticality (see: [Priority & Risk](/en/working_with_findings/priority_adjustments/)), RBAC, and corresponding Engagements and Tests. You could continue to test, and store results, on the parent Asset (for example, `webapp-backend`), but you could also run isolated testing on a particular child Asset (for example, `database`). |
| 66 | + |
| 67 | +### Pen Tests: Isolated RBAC |
| 68 | + |
| 69 | +If you want to store pen test results within a single asset, but you don't want testers to be able to look at asset data, you could create child assets for each testing group to upload their results. |
| 70 | + |
| 71 | +``` |
| 72 | +Core Application [Organization] |
| 73 | +└── webapp-frontend [Parent Asset] |
| 74 | + ├── Pen Test Group A |
| 75 | + └── Pen Test Group B |
| 76 | +``` |
| 77 | + |
| 78 | +Crucially, giving a user RBAC access to a single Child Asset (e.g. `Pen Test Group A`) here does not allow them to see any Findings from other Child Assets (e.g. `Pen Test Group B`), nor does it allow them to see Findings in the Parent Asset (`webapp-frontend`). |
| 79 | + |
| 80 | +The Parent Asset could contain Engagements representing CI/CD results, internal Testing, historical data, or other Finding data which you do not want 3rd parties to be able to discover. Creating a Child Asset for specific Test results allows your internal team to report on those results in combination with the state of the parent Asset. |
| 81 | + |
| 82 | +## Visualizing Assets - Hierarchy |
| 83 | + |
| 84 | +You can visualize the structure of Assets in DefectDojo, and change relationships using the Asset Hierarchy option in the menu. |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | +Opening Asset Hierarchy will display a table of all of your Assets which can be filtered. Selecting one or more Assets from this table will render a hierarchy diagram. |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | +### Diagram navigation |
| 93 | + |
| 94 | +The icons at the top left of the hierarchy diagram allow you to zoom in and out. Clicking and dragging in this diagram allows you to scroll through the diagram. |
| 95 | + |
| 96 | +Each Asset is rendered as a single node in this diagram, which can be moved around for display purposes. |
| 97 | + |
| 98 | +Assets are connected together using labelled paths, which represent the kind of relationship each note has to one another. Currently, `parent` is the only label supported. |
| 99 | + |
| 100 | +### Exploring Asset nodes |
| 101 | + |
| 102 | +Each Asset node can be interacted with by clicking on the blue buttons. These buttons appear only when an Asset node is selected (by clicking on the node). |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | +* 👁️ (eyeball icon) will take you directly to the corresponding Asset View (formerly known as the Product View). |
| 107 | +* ✏️ (pencil icon) will open a modal with the Edit Asset form (formerly known as the Edit Product form) |
| 108 | +* ➕ (plus icon) will allow you to add a new Child Asset to this Asset. The Asset does not need to be currently visible in the diagram, but must be part of the same Organization. |
| 109 | +* ✥ (four-arrows icon) allows you to change the Parent Asset of the currently selected Asset. |
| 110 | +* 🗑️ (trash can icon) allows you to remove an Asset's parent relationship. This icon only appears if an Asset already has a Parent. |
| 111 | + |
| 112 | +If your diagram displays an Asset with un-selected Parent Assets, you can click the Load More button to populate the diagram with the Parent Asset (as well as that Parent Asset's children). |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | +## Notes |
| 117 | + |
| 118 | +* Note that deduplication scopes have not changed; Assets only deduplicate Findings within themselves, and do not consider Findings in other Assets, regardless of Parent/Child relationships. |
| 119 | +* RBAC scopes have not changed within this system; each Asset is still considered an individual object for the purposes of assigning permissions. No new RBAC inheritance has been created. |
| 120 | + * Giving a user access to an entire Organization will still give that user access to all Assets contained within that Organization (as with Product Types). |
| 121 | + * Giving a user access to a single Asset does not give that user access to any related Parent or Child Assets, nor access to the Organization. |
| 122 | +* There is no limit to the number of Parent/Child relationships that can be created. Theoretically, you could represent a repository's entire directory structure with separate Assets if you wished. |
| 123 | +* Cyclical relationships are not allowed: Parent Assets cannot be Children of their Child Assets. |
0 commit comments