- Logs should not expose sensitive data (e.g., tokens, passwords)
- These checks are part of the standard requirements. If any of them fail, the application will be rejected at this stage. So, it's always a good idea to double-check these points before submitting-this will help make the validation process faster and smoother for your app.
Secure Coding checks:
You can follow the complete review process and best practices to avoid delays or rejection during app validation.
A helpful guide is available here: https://community.ibm.com/community/user/security/blogs/jawine-westland/2024/08/19/preparing-your-app-for-secure-coding?CommunityKey=4b5d78c9-2135-48b2-9bbb-0825224461c1
If your app passes the security review, it will be signed, any required certificates will be added, and it will move forward in the publishing process.
However, if any security issues are found, they will be explained in a detailed report, and the app will be returned for fixes. In that case, you’ll be notified of the changes needed before resubmitting.
By following the shared best practices, you can make the process faster and improve the chances of your app being approved.
Note: When submitting or re-submitting your application, it's highly recommended to include your plaintext (unminified) source code, UI files, and package.json / package-lock.json files (if applicable). This helps the secure coding team begin their review immediately, without delays, and ensures you receive feedback faster
Document Verification:
This phase is for IBM internal apps, where we publish the app documentation before releasing the apps, to ensure that the documentation is up to date prior to publication.
It is recommended to create a documentation ticket and share it with the content team either while submitting the app or shortly afterward. This ensures they are aware of the app’s details and can speed up the validation process.
App Val 2:
Once the secure coding team signs your app, we will then perform the App Validation 2 checks. During this step, we verify that the newly signed zip file is functioning correctly and works as expected.
If the app is working as expected, we will proceed with publishing it and send you an email notification once it's done.
Publish App:
In this step, we follow the app publishing process, which includes sending an email with details such as the app version, 'What’s New' information, and other relevant updates.
FAQ:
- Is the Pre-Validation report mandatory?
- Yes, the Pre-Validation report is mandatory every time you submit or re-submit your application. Make sure it’s the latest report and that your app passes all checks
- My Pre-Validation report is failing at Extension Signing. What should I do?
- Ensure your app is properly signed.
If it's failing:
- Check the folder structure of your application zip.
- Make sure there are no hidden directories at the time of signing.
- Once signed correctly, re-run the Pre-Validation tool
- What is the Testing Information in the Submission portal?
- It's a section where you provide login details, steps, and any setup info needed to test your app.
- What type of testing information will be provided?
- Include:
- Test credentials (if needed)
- Sample data or log sources
- Steps to verify app functionality
- Any specific user roles or settings required for testing
Summary:
In this blog, we learned how the QRadar App Validation team thoroughly checks applications and content packs to ensure they work correctly, are secure, and meet platform standards. By following best practices - such as validating installation and updates, ensuring secure coding, providing clear documentation, and submitting accurate pre-validation reports - developers can streamline the approval process and increase the chances of their apps being successfully published.