Skip to content

Security: middleware-labs/middleware_dart_opentelemetry

Security

SECURITY.md

Security Policy

Supported Versions

Below are the versions of the OpenTelemetry SDK for Dart that are currently supported with security updates:

Version Supported
0.8.x
< 0.8.0

Reporting a Vulnerability

We take the security of OpenTelemetry SDK for Dart seriously. If you believe you have found a security vulnerability, please follow these steps:

  1. Do not disclose the vulnerability publicly
  2. Contact the maintainers privately - Email [email protected] with details of the vulnerability
  3. Provide sufficient information to reproduce the issue, including:
    • Description of the vulnerability
    • Steps to reproduce
    • Potential impact
    • Suggested mitigation if available

What to Expect

After you report a vulnerability:

  1. Acknowledgment - You will receive acknowledgment of your report within 48 hours
  2. Verification - Our team will work to verify the vulnerability
  3. Remediation Plan - We will develop a plan to address the vulnerability
  4. Public Disclosure - Once a fix is available, we will coordinate with you on public disclosure

Security Best Practices

When using OpenTelemetry SDK for Dart:

  1. Keep the package updated to the latest supported version
  2. Review your telemetry data to ensure sensitive information is not inadvertently collected
  3. Apply appropriate access controls to your telemetry data collection endpoints
  4. Consider using TLS for all telemetry data transmission
  5. Implement appropriate sampling strategies to limit the volume of data collected
  6. Configure span processors to handle data securely
  7. Use secure connections for exporters that transmit data over the network

Security Considerations for Telemetry Data

When implementing OpenTelemetry:

  1. Data Minimization - Only collect the telemetry data necessary for your use case
  2. PII Protection - Avoid including personally identifiable information in spans or metrics
  3. Sensitive Data - Avoid including sensitive information such as authentication tokens in attributes
  4. Network Security - Use secure connections (TLS) when exporting telemetry data
  5. Authentication - Consider using authentication for your OpenTelemetry Collector endpoints
  6. Access Control - Implement appropriate access controls for your telemetry data
  7. Sanitization - Consider implementing sanitization for sensitive attributes
  8. Sampling - Use sampling to reduce the volume of potentially sensitive data

Additional SDK-Specific Security Considerations

  1. Exporters: Configure exporters to use secure connections (e.g., HTTPS, gRPC with TLS)
  2. Resource Attributes: Be cautious about automatically adding host or environment information that might expose sensitive details
  3. Batch Processing: Configure batch processors with appropriate queue sizes and timeouts to prevent memory exhaustion
  4. Error Handling: Ensure that error handling in span processors doesn't leak sensitive information
  5. Configuration: Securely manage any API keys or authentication tokens used in exporter configurations

Disclosure Policy

Our disclosure policy is:

  1. Security issues will be announced via GitHub security advisories
  2. CVEs will be requested when appropriate
  3. Fixed versions will be clearly identified in release notes
  4. Security patches will be prioritized over feature development

There aren’t any published security advisories