Skip to content

Commit 5bf56c7

Browse files
committed
docs: add note about updating the npm dependencies
1 parent 5b62201 commit 5bf56c7

File tree

4 files changed

+18
-4
lines changed

4 files changed

+18
-4
lines changed

docs/pages/about.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ This site offers a more organized and structured approach to documenting the sof
1313
<Callout>
1414
As of <u>July 2024</u>, **ACAP 2.0**, which includes new features and upgrades, is the latest version of ACAP and will be referred to simply as **"ACAP"** until further notice.
1515
</Callout>
16+
17+
Check out the [ACAP Changelog](/changelog) page for information about the ACAP versions developed and released from 2022 to 2024.

docs/pages/announcements.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Cards, Image } from 'nextra/components'
55
<br />
66

77
<Cards num={1}>
8-
<Cards.Card arrow title="Firebase Storage Pricing Updates" href="/announcements/firebase-storage-2024">
8+
<Cards.Card arrow title="Firebase Storage Pricing Updates 2024" href="/announcements/firebase-storage-2024">
99
<>![Documentation theme](/assets/docs-theme.png)</>
1010
</Cards.Card>
1111
</Cards>

docs/pages/announcements/firebase-storage-2024.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,16 +134,20 @@ _All Firebase components service usage (including those not used by ACAP) will o
134134
<div id="security-considerations" />
135135
<FAQBox title="Are there security considerations that I should be aware of?" color="text-red-700 dark:nx-text-red-200">
136136

137-
Yes. <u>Some of the latest core deliverables</u> implemented for ACAP in its [2.0](/changelog/#version-2-acap-20) version [**introduced security considerations**](/changelog#acap-2-security-debts) not present in the initial ([1.0](/changelog/#version-1-acap-10)) version, which followed a more rigid [security](/security) model that adhered to best practices in web development security. The security changes in **version 2.0** resulted in a **measured reduction in coverage compared to version 1.0, <u>based on established criteria.</u>**
137+
Yes. <u>Some of the latest core deliverables</u> implemented for ACAP in its [2.0](/changelog/#version-2-acap-20) version [**introduced security considerations**](/changelog#acap-2-security-debts) not present in the initial ([1.0](/changelog/#version-1-acap-10)) version, which followed a more rigid [security model](/security) that adhered to best practices in web development security. The security changes in **version 2.0** resulted in a **measured reduction in coverage compared to version 1.0, <u>based on established criteria.</u>** (see table below)
138138

139139
<Callout>
140140
> With **ACAP 2.0+**, core development transitioned to a <u><b>new lead programmer</b></u> who <u>made changes to improve development speed</u>. As part of this effort, they introduced a <u>more flexible Firestore database setup</u>, which streamlined workflows. While these adjustments optimized workflows, they also <u><b>altered security rules, introducing new considerations that require further refinements</b></u> to align with [best practices](/security).
141141
>
142-
> The <u><b>lead programmer</b></u> is aware of these trade-offs, and <u>since they made these changes, they remain the best point of contact for security updates and fixes.</u>
142+
> The <u><b>lead programmer</b></u> is aware of these trade-offs, and <u>since the lead programmer made these changes, they remain the best point of contact for security updates and fixes.</u>
143143
>
144144
> For more details on these changes, refer to this GitHub [issue](https://github.com/amia-cis/acap-v2/issues/57) in the parent **acap-v2** repository, which provides a summary of the <b>lead programmer's</b> <u>upcoming fixes and improvements.</u>
145145
</Callout>
146146
147+
##### ACAP Security Criteria
148+
149+
This table shows the overall security criteria ensured and accounted for by ACAP's best practices in its recommended [security guidelines](/security).
150+
147151
| Criteria | Purpose | ACAP [1.0](/changelog/#version-1-acap-10) | ACAP [2.0](/changelog/#version-2-acap-20) |
148152
| --- | --- | :---: | :---: |
149153
| User authentication | Authorized, allowed, and predictable operations access to resources |||

docs/pages/security.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ACAP's [Firestore Security Rules](https://firebase.google.com/docs/firestore/sec
4747
```
4848

4949
<Callout type="warning">
50-
[ACAP 2.0](/changelog/#version-2-acap-20) allowed users to <u>edit crop recommendations, a new feature</u> introduced in **version 2.0** through <u>weak Firestore Security Rules</u>, making it vulnerable to **Cross-Site Scripting (XSS)**. This lets **unauthorized clients** (e.g., Postman) <u><i>modify WYSIWYG-form data without protection</i></u> if accessed from the [Firestore REST APIs](https://cloud.google.com/firestore/docs/reference/rest/). Allowing these in the Firestore Security Rules contradicts the best practices outlined in the [Database](#database) section.
50+
[ACAP 2.0](/changelog/#version-2-acap-20) allowed users to <u>edit crop recommendations, a new feature</u> introduced in **version 2.0** through <u>weak Firestore Security Rules</u>, making it vulnerable to **Cross-Site Scripting (XSS)**. This lets **unauthorized clients** (e.g., Postman) <u><i>modify WYSIWYG-form data without protection</i></u> if accessed from the [Firestore REST APIs](https://cloud.google.com/firestore/docs/reference/rest/). Allowing these in the Firestore Security Rules contradicts the best practices outlined in the [Database](#database) section, which advocates for data mutation with thorough <u>data validation</u> in the **Node backend**.
5151

5252
For more details, refer to GitHub Issues in the parent **acap-v2 repository** ([[1]](https://github.com/amia-cis/acap-v2/issues/34), [[2]](https://github.com/amia-cis/acap-v2/issues/57)) or check the **Firebase Storage Announcements 2024** under the [Are there security concerns I should be aware of?](/announcements/firebase-storage-2024#security-considerations) section for information and reference.
5353
</Callout>
@@ -91,6 +91,14 @@ ACAP's [Firebase Storage Security Rules](https://firebase.google.com/docs/storag
9191
These Security requirements carry over and apply to **ACAP 2.0**, even if the Software documents were written for **ACAP 1.0**. Since no new Software documents are available for the updates made in ACAP 2.0, you may <u>consult the new lead programmer</u> responsible for implementing ACAP 2.0 <u>about detailed upgrades specifics made to the system</u>.
9292
</Callout>
9393

94+
## Node Package Libraries (NPM)
95+
96+
ACAP, a web application built with Firebase, Express, React/Next.js, and Node.js, relies on open-source development libraries from the **Node Package Manager (NPM)** for its **client** and **server** applications.
97+
98+
Since ACAP's initial development in 2022, many of these libraries may have become outdated as newer versions are released.
99+
100+
Developers maintaining ACAP are encouraged to <u>monitor and update these dependencies as needed</u> to benefit from performance improvements, security patches, and new features, possibly requiring using <u>newer Node versions</u>.
101+
94102
## Related
95103

96104
- [Server Notes](/directories/server)

0 commit comments

Comments
 (0)