finos / secure-electron-adapter

This project is archived, which means that it's in read-only state; you can download and use this code, but please be aware that it may be buggy and may also contain security vulnerabilities. If you're interested to restore development activities on this project, please email [email protected].

Secure Electron Adapter

ChartIQ's Secure Electron Adapter provides an easy way to create an Electron application that adheres to Electron's own security recommendations by design.

Installation

npm install secure-electron-adapter --save

Usage example

See sea-quick-start for example usage.

To debug:

• Open Chrome and navigate to chrome://inspect
• Click "Open Dedicated Devtools for Node"
• Select "Add connection" under the Connection tab
• Enter localhost:5858 (the port can be found in the sea package.json in the startbrk section under the flag --inspect-brk)
• Under the Sources tab, click on the Node subheading to see the sources list.

Code Organization

• index.js is the file that will run in the deployed Electron application.
• exports.js is a collection of files that you would traditionally assume is exported by a node module.
• src/Main is code that runs inside of Main process of Electron.
• src/Render is code that runs inside of the browser.

Contributing

1. Fork it (https://github.com/finos/secure-electron-adapter/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Read our contribution guidelines and Community Code of Conduct
4. Commit your changes (git commit -am 'Add some fooBar')
5. Push to the branch (git push origin feature/fooBar)
6. Create a new Pull Request

NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

Need an ICLA? Unsure if you are covered under an existing CCLA? Email [email protected]

License

Copyright 2018 ChartIQ

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

secure-electron-adapter's Issues

Request for project archiviation

This project seems to be inactive since 2020, therefore I'd like to request its archiviation.

If anyone would be interested to restore activity, at any time, please comment on this issue.

If there is no reaction in the following 14 days, the FINOS team will proceed with the archiviation.

Transfer project to FINOS

Transfer is scheduled on Wednesday 22 April, 1pm EST

Prior to transfer

• Create project website homepage (1-pager) with same (basic) contents from README.md.
• Review README.md and other FINOS blueprint contents, making sure contribution guidelines (how to send a PR, how to open an issue, how to get started, ...) are clear.
• Add @finos-admin user as Admin to all GitHub repositories to contribute

During the transfer

• Transferring GitHub repositories (sea and quickstart) to github.com/finos
• Test Git redirects
• Test https://sea.finos.org

After the transfer

• Working with Marketing teams on project website and announcements
• Create GitHub Action to test and build
• Release to FINOS NPM repo
• Add semantic release to automate release process

Add project logo to readme and sea.finos.org

I see a logo for SEA exists.

Can we add it to the README and the sea.finos.org website?

Replace the word "secure" from the project name per new FINOS Project Branding guidelines

As part of joining the Linux Foundation, FINOS has recently cleaned up governing documents, policies and guidelines.

One of the recently introduced guidelines offers comprehensive guidance to projects on how to brand their project in compliance to the FINOS trademark guidelines and beyond that provide recommendations around project naming to set up projects for long term success in the Community.

The Project Branding guidelines includes the specific recommendation to avoid to:

Imply a particular level of service or might otherwise create liability (e.g. supported, secure, fastest, etc.)

Based on this recommendation, prior to the next release, I would ask the Project team to consider replacing the word "secure" in the project name or come up with a new name altogether. We'd be happy to support the work to come up with a new name as well as to produce a logo like we do for all projects.

Appreciate your cooperation and please let us know if you have any questions.

/cc @toshaellison @brooklynrob @mcleo-d @maoo