feat(agent): add support for csec php agent #918
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,6 +25,7 @@ by e-mailing [[email protected]](mailto:[email protected]). | |
| * [Portable OpenSSH](#portable-openssh) | ||
| * [TSRM](#tsrm) | ||
| * [Symfony](#symfony) | ||
| * [New Relic PHP Security Agent](#new-relic-php-security-agent) | ||
|
|
||
| ## cJSON | ||
|
|
||
|
|
@@ -957,3 +958,67 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| THE SOFTWARE. | ||
| ``` | ||
|
|
||
| ## New Relic PHP Security Agent | ||
|
|
||
| This product includes source derived from | ||
| [New Relic csec-php-agent](https://github.com/newrelic/csec-php-agent), distributed under the | ||
| [New Relic Pre-Release Software Notice](https://github.com/newrelic/csec-php-agent/blob/main/LICENSE): | ||
|
|
||
| ## New Relic Pre-Release Software Notice | ||
|
|
||
| ### Acceptance | ||
|
|
||
| ``` | ||
| This software license applies to the repositories, directories, or files that it has been associated with (referred to here as the "Pre-Release Software"). In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses. | ||
| License | ||
|
|
||
| New Relic, Inc. ("New Relic") grants you a license under its copyrights and patents to do everything necessary for you to use the Pre-Release Software for the Permitted Purposes and subject to your compliance with the Confidentiality terms and all other Restrictions on Use. All other uses are prohibited. | ||
| ``` | ||
|
|
||
| ### Permitted Purposes | ||
|
|
||
| ``` | ||
| The Pre-Release Software is solely for use with New Relic's proprietary SaaS service ("New Relic Service"). To use the Pre-Release Software you must have a valid and active subscription agreement to the New Relic Service. You may not use the Pre-Release Software in conjunction with any other similar service. | ||
|
|
||
| Use of the Pre-Release Software is limited to evaluation and feedback, including pull requests, of the pre-release features and capabilities. The use of the Pre-Release Software requires a signed New Relic Pre-Release Agreement. The New Relic Pre-Release Agreement will control in event of a conflict with this license. The Pre-Release Software is also subject to the New Relic pre-release policy. A copy of the New Relic Pre-release policy available at https://docs.newrelic.com/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy/. | ||
| ``` | ||
|
|
||
| ### Confidentiality | ||
|
|
||
| ``` | ||
| Any Pre-Release Software not posted publicly contains New Relic Trade Secrets. You may not disclose the features and capabilities of the Pre-Release Software to any third party by any means. You will use commercially reasonable measures to maintain the secrecy of the features and capabilities of the Pre-Release Software. Without limiting the permissions you receive under any open source software ("OSS") license, you may not disclose the source code of any OSS included as part of the Pre-Release Software in a way that discloses the New Relic Trade Secrets. | ||
| ``` | ||
|
|
||
| ### Restrictions on Use | ||
|
|
||
| ``` | ||
| 1. The use of the Pre-Release Software is limited to you and your organization. You cannot expose the Pre-Release Software to third parties via the network or use the Pre-Release Software on behalf of anyone else. | ||
| 2. You cannot modify the Pre-Release Software. You can compile or link the Pre-Release Software into your programs as described in the New Relic Documentation, but you cannot otherwise make any derivative works of the Pre-Release Software. | ||
| 3. You cannot reverse engineer or decompile the Pre-Release Software. | ||
| 4. You cannot use the Pre-Release Software for competitive analysis, benchmarking, or any purposes that compete with or are intended to compete with New Relic. | ||
| 5. You cannot remove or obscure any proprietary notices in the Pre-Release Software. | ||
| 6. You can only copy the Software to the extent needed to use the Pre-Release Software within your organization. You cannot distribute the Software to any third parties. | ||
| 7. You can only use the New Relic Services and the Pre-Release Software consistent with New Relic's product Documentation and Acceptable Use Policy. | ||
| ``` | ||
|
|
||
| ### Intellectual Property | ||
|
|
||
| ``` | ||
| Any feedback provided to New Relic about the Pre-Release Software, including feedback provided as source code, comments, or other copyrightable or patentable material, is provided to New Relic under the terms of the Apache Software License, version 2. If you do not provide attribution information or a copy of the license with your feedback, you waive the performance of those requirements of the Apache License with respect to New Relic. The license grant regarding any feedback is irrevocable and persists past the termination of this license. | ||
| ``` | ||
|
|
||
| ### Termination | ||
|
|
||
| ``` | ||
| This license terminates when the Pre-Release Software stops being provided by New Relic or when described by the New Relic Pre-Release Agreement, whichever comes first. When this license terminates, you have a commercially reasonable time to either remove the Pre-Release Software from your systems or to upgrade to a publicly released version of the Software. | ||
| ``` | ||
|
|
||
| ### Other Terms | ||
|
|
||
| ``` | ||
| 1. The Pre-Release Software is provided "AS IS." New Relic disclaims all warranties, whether express, implied, statutory or otherwise, including warranties of merchantability, fitness for a particular purpose, title and noninfringement. | ||
| 2. The Pre-Release Software has known flaws. You use the Pre-Release Software at your own risk. | ||
| 3. To the full extent permitted by law, New Relic will have no liability arising from or related to the Pre-Release Software or from this license for any direct, indirect, special, incidental, or consequential damages of any kind, even if advised of their possibility in advance, and regardless of legal theory (whether contract, tort, negligence, strict liability or otherwise). | ||
| 4. The Pre-Release Software may contain third-party software, including open source software. The third party software is governed by its own license and subject to its own terms, disclosed in the provided licensing information associated with the third party components. If a source code disclosure is required under the terms of the license covering any OSS component, the source code can be requested of New Relic by emailing [email protected]. | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| #include "csec_metadata.h" | ||
| #include "util_strings.h" | ||
| #include "php_hash.h" | ||
| #include "php_api_internal.h" | ||
|
|
||
| static void nr_csec_php_add_assoc_string_const(zval* arr, | ||
| const char* key, | ||
| const char* value) { | ||
| char* val = NULL; | ||
|
|
||
| if (NULL == arr || NULL == key || NULL == value) { | ||
| return; | ||
| } | ||
|
|
||
| val = nr_strdup(value); | ||
| nr_php_add_assoc_string(arr, key, val); | ||
| nr_free(val); | ||
| } | ||
|
|
||
| #ifdef TAGS | ||
| void zif_newrelic_get_security_metadata(void); /* ctags landing pad only */ | ||
| void newrelic_get_security_metadata(void); /* ctags landing pad only */ | ||
| #endif | ||
| PHP_FUNCTION(newrelic_get_security_metadata) { | ||
|
|
||
| NR_UNUSED_RETURN_VALUE; | ||
| NR_UNUSED_RETURN_VALUE_PTR; | ||
| NR_UNUSED_RETURN_VALUE_USED; | ||
| NR_UNUSED_THIS_PTR; | ||
| NR_UNUSED_EXECUTE_DATA; | ||
|
|
||
| array_init(return_value); | ||
|
|
||
| nr_csec_php_add_assoc_string_const(return_value, KEY_ENTITY_NAME, nr_app_get_entity_name(NRPRG(app))); | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_ENTITY_TYPE, nr_app_get_entity_type(NRPRG(app))); | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_ENTITY_GUID, nr_app_get_entity_guid(NRPRG(app))); | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_HOSTNAME, nr_app_get_host_name(NRPRG(app))); | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_LICENSE, NRPRG(license).value); | ||
|
|
||
| if (NRPRG(app)) { | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_AGENT_RUN_ID, NRPRG(app)->agent_run_id); | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_ACCOUNT_ID, NRPRG(app)->account_id); | ||
| nr_csec_php_add_assoc_string_const(return_value, KEY_PLICENSE, NRPRG(app)->plicense); | ||
| int high_security = NRPRG(app)->info.high_security; | ||
| add_assoc_long(return_value, KEY_HIGH_SECURITY, (long)high_security); | ||
| } | ||
|
|
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| #include "php_agent.h" | ||
| #include "util_hashmap.h" | ||
|
|
||
| #define KEY_ENTITY_NAME "entity.name" | ||
| #define KEY_ENTITY_TYPE "entity.type" | ||
| #define KEY_ENTITY_GUID "entity.guid" | ||
| #define KEY_HOSTNAME "hostname" | ||
| #define KEY_AGENT_RUN_ID "agent.run.id" | ||
| #define KEY_ACCOUNT_ID "account.id" | ||
| #define KEY_LICENSE "license" | ||
| #define KEY_PLICENSE "plicense" | ||
| #define KEY_HIGH_SECURITY "high_security" | ||
|
Comment on lines
+4
to
+12
There was a problem hiding this comment. Are all these values really required by csec-agent? Why? When does the csec-agent going to use these values? Some of these values can change within a request if PHP code calls There was a problem hiding this comment. Yes, the backend (Security Engine) uses these values to correctly map all the information for application, incidents, etc. csec-agent sends this information with the events. There was a problem hiding this comment.
I really doubt that backend will use
I do not understand your answer. If csec-agent is going to retrieve this information before There was a problem hiding this comment. We are logging some of these values, and that includes the license as well. Logging for license in particular has to be masked, and hence the reason for plicense. Unmasked license logging has previously being flagged at some agent. At any point of time, when the apm agent is connected, entity.name is going to have a value along with entity.guid. When the newrelic_set_appname is called, csec-agent will be using that value on next reconnect cycle to the server. So, yes as soon as newrelic_set_appname is called, entity.name and entity.guid will not change for the csec-agent but on the next reconnect (this is planned at SE, the backend), the events will be mapped to new entity.name and entity.guid, this would reset the values for all the running and connected processes. csec-agent tries to retrieve the metadata at the beginning of each request until it has data. It will wait for next reconnect cycle with server to see if anything has changed. csec-agent generates the events based on the hooks and send the data immediately to the backend. As has been detailed the intent of using newrelic_set_appname as early as possible in code, taking runtime values from APM agent would not affect the app's data at backend. There was a problem hiding this comment.
This is exactly why php-agent team has a problem with this. Not only there's potential for incorrect mapping of an event to an app, but also this depends on wether php-agent has been initialized before csec-agent, which we cannot see how it can be guaranteed. Why doesn't csec-agent retrieve the metadata only at the time it is needed, in the 'hook' you mention here:
There was a problem hiding this comment. csec-agent takes the connection information from the apm agent only. It does not generate any data until the apm agent has been connected. csec-agent is completely reliant on APM agent for entity.guid. There was a problem hiding this comment. And without entity.guid, it does not connect to the backend |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -515,6 +515,58 @@ static PHP_INI_MH(nr_high_security_mh) { | |
| return SUCCESS; | ||
| } | ||
|
|
||
| static PHP_INI_MH(nr_security_enabled_mh) { | ||
| int val; | ||
|
|
||
| (void)entry; | ||
| (void)NEW_VALUE_LEN; | ||
| (void)mh_arg1; | ||
| (void)mh_arg2; | ||
| (void)mh_arg3; | ||
| (void)stage; | ||
| NR_UNUSED_TSRMLS; | ||
|
|
||
| val = nr_bool_from_str(NEW_VALUE); | ||
|
|
||
| if (-1 == val) { | ||
| return FAILURE; | ||
| } | ||
|
|
||
| if (val) { | ||
| NR_PHP_PROCESS_GLOBALS(nr_security_enabled) = true; | ||
| } else { | ||
| NR_PHP_PROCESS_GLOBALS(nr_security_enabled) = false; | ||
| } | ||
|
|
||
| return SUCCESS; | ||
| } | ||
|
|
||
| static PHP_INI_MH(nr_security_agent_enabled_mh) { | ||
| int val; | ||
|
|
||
| (void)entry; | ||
| (void)NEW_VALUE_LEN; | ||
| (void)mh_arg1; | ||
| (void)mh_arg2; | ||
| (void)mh_arg3; | ||
| (void)stage; | ||
| NR_UNUSED_TSRMLS; | ||
|
|
||
| val = nr_bool_from_str(NEW_VALUE); | ||
|
|
||
| if (-1 == val) { | ||
| return FAILURE; | ||
| } | ||
|
|
||
| if (val) { | ||
| NR_PHP_PROCESS_GLOBALS(nr_security_agent_enabled) = true; | ||
| } else { | ||
| NR_PHP_PROCESS_GLOBALS(nr_security_agent_enabled) = false; | ||
| } | ||
|
|
||
| return SUCCESS; | ||
| } | ||
|
|
||
| static PHP_INI_MH(nr_preload_framework_library_detection_mh) { | ||
| int val; | ||
|
|
||
|
|
@@ -2009,6 +2061,18 @@ PHP_INI_ENTRY_EX("newrelic.high_security", | |
| nr_high_security_mh, | ||
| 0) | ||
|
|
||
| PHP_INI_ENTRY_EX("newrelic.security.agent.enabled", | ||
| "0", | ||
| NR_PHP_SYSTEM, | ||
| nr_security_agent_enabled_mh, | ||
| 0) | ||
|
|
||
| PHP_INI_ENTRY_EX("newrelic.security.enabled", | ||
| "0", | ||
| NR_PHP_SYSTEM, | ||
| nr_security_enabled_mh, | ||
| 0) | ||
|
|
||
|
Comment on lines
+2064
to
+2075
There was a problem hiding this comment. Does the newrelic-php-agent need these settings? They don't seem to be used anywhere... There was a problem hiding this comment. newrelic.security.agent.enabled and newrelic.security.enabled settings are logged in the APM log file if these settings are disabled in the minit function There was a problem hiding this comment. Will the values of these settings be used by the security agent as well? There was a problem hiding this comment. Yes, these values are to be used by the security agent as well as mentioned here in comment. |
||
| /* | ||
| * Feature flag handling. | ||
| */ | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this function need to be called from PHP?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No but this function will be called by the Security Agent
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If that's the case then this shouldn't be a PHP user function but a function exported by newrelic-php-agent shared object, callable from a program by the means of dynamic binding - see https://linux.die.net/man/3/dlsym.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
newrelic-php-agent already does similar thing - see here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Michal, I will update the code and not expose this as a PHP user function. Thanks for the reference too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried the dynamic call using dlopen and dlsym, but seems like the values may not be accessible.
nr_app_get_entity_name(NRPRG(app))is one of the calls which is required, butNRPRGis the zend module's address space which does not seem accessible directly.fprintf(stderr, "%p : newrelic_globals.app\n", NRPRG(app));gives
(nil)when called from dlopen'ed binary while from inside a valid address is printed.Lets connect over call to finalise a solution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anmol-ap Please take a look at #922 - it should have what's needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the special purpose value for handle worked. Thanks.