Package Health Score

50 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
5.68.5	\|	03/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.47.4	\|	03/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.47.1	\|	01/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.8	\|	08/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (6)

GitHub Stars: 13
Forks: 8
Contributors: 7

Direct Usage Popularity

The npm package wickrio_web_interface receives a total of 6 downloads a week. As such, we scored wickrio_web_interface popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package wickrio_web_interface, we found that it has been starred 13 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 7
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 1
Last Release: 4 years ago
Last Commit: 1 month ago

Further analysis of the maintenance status of wickrio_web_interface based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for wickrio_web_interface is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 12 Direct
Versions: 28
Install Size: 31.8 kB
Dist-tags: 1
# of Files: 11
Maintainers: 2
TS Typings: No

wickrio_web_interface has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

WickrIO API Web Interface

The official WickrIO Web API tool. Allows to send HTTP requests to communicate with the WickrIO API, and also makes it possible to create Wickr Integrations using any programming language.

To get started with the WickrIO Web API Interface:

First, you would need to setup your system, download and install Docker and run the WickrIO Docker container. Full instructions on how to do so are available here: https://wickrinc.github.io/wickrio-docs/#wickr-io-getting-started

Configuration:

Run configure.sh after installing the Web API Interface software module, it will propmpt you to configure several properties that are needed to access the URL endpoints. The WickrIO console will walk you through entering the following values:

BOT_USERNAME = This is the username of the WickrIO client. If prompted enter that value.
BOT_PORT = The TCP/IP port that the Wickr IO bot will listen on. NOTE: you will have to add the port to the docker run command that starts the Wickr IO Docker container so that port is made available to the Wickr IO integration software.
BOT_API_KEY = The API Key that is used in every endpoint call. This is the \ value that is contained in every endpoint URL.
BOT_API_AUTH_TOKEN = The authentication string used to generate the Base64 value to be sent in the authorization field of the HTTP Header (Recommended: 24-character alphanumeric string). You will need to generate a Base64 value of this token and the add it to the HTTP authorization header (i.e. Basic MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNA==).
HTTPS_CHOICE = Choose whether to use an HTTPS server instead of the default HTTP. It is highly recommended that HTTPS be used for security.
SSL_KEY_LOCATION = Full path name of the .key file (only required if you are going to use HTTPS). The file must be located in the shared directory that the integration software running on the Docker image can access.
SSL_CERT_LOCATION = Full path name of the .cert file (only required if you are going to use HTTPS). The file must be located in the shared directory that the integration software running on the Docker image can access.

For HTTPS and SSL support, you need an OpenSSL certificate file and a key file. Both can be created with the following command:

``` openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout my.key -out my.cert ``` ### Authentication

This version of the Web Interface supports basic authentication. The authentication will use the "Authorization" HTTP header to send the necessary authentication information to the Wickr IO server. If the proper authentication information is not presented to the Wickr IO server then an HTTP 401 response will be sent.

When using basic authentication, a base64 encoded string will be sent to the Wickr IO server. The following steps should be performed for basic authentication:

When the associated Wickr IO bot client is configured and associated with the Web Interface integration, the associated authentication string will be setup. You will use this string to generate the base64 encoded string.
Base64 encode the string mentioned above.
Supply an "Authorization" header with content "Basic " followed by the encoded string. For example, the string "The big red fox" encodes to "VGhlIGJpZyByZWQgZm94" in base 64, so you would send the string "Basic VGhlIGJpZyByZWQgZm94" in the "Authorization" HTTP header.

Web Interface REST API

This section describes the REST APIs that are supported by the 2.x version of the Wickr IO Web Interface integration. The following table identifies each of the actions the API supports, the type of HTTP request and the URL used.

API	HTTP	URL
Send Message	POST	https://:/WickrIO/V1/Apps//Messages
Set Message URL Callback	POST	https://:/WickrIO/V1/Apps//MsgRecvCallback?callbackurl=\
Get Message URL Callback	GET	https://:/WickrIO/V1/Apps//MsgRecvCallback
Delete Message URL Callback	DELETE	https://:/WickrIO/V1/Apps//MsgRecvCallback
Get Received Messages	GET	https://:/WickrIO/V1/Apps//Messages?start=&count=\
Get Statistics	GET	https://:/WickrIO/V1/Apps//Statistics
Clear Statistics	DELETE	https://:/WickrIO/V1/Apps//Statistics
Create Secure Room	POST	https://:/WickrIO/V1/Apps//Rooms
Get Room	GET	https://:/WickrIO/V1/Apps//Rooms/\
Get Rooms	GET	https://:/WickrIO/V1/Apps//Rooms
Delete Room	DELETE	https://:/WickrIO/V1/Apps//Rooms/\
Leave Room	DELETE	https://:/WickrIO/V1/Apps//Rooms/&reason=leave
Modify Room	POST	https://:/WickrIO/V1/Apps//Rooms/\
Create Group Conversation	POST	https://:/WickrIO/V1/Apps//GroupConvo
Get Group Conversations	GET	https://:/WickrIO/V1/Apps//GroupConvo
Get Group Conversation	GET	https://:/WickrIO/V1/Apps//GroupConvo /\
Delete Group Conversation	DELETE	https://:/WickrIO/V1/Apps//GroupConvo/\
Get Directory	GET	https://:/WickrIO/V1/Apps//Directory

The \ value is the value you entered during the configuration of the Wickr Web Interface intagration.

Usage:

For full documentation and for information on all of the endpoints and requirements visit: https://wickrinc.github.io/wickrio-docs/#web-interface-rest-api

wickrio_web_interface dependencies

fs body-parser express helmet cron csv-writer log4js pm2 prompt dotenv wickrio-bot-api multer

FAQs

What is wickrio_web_interface?

WickrIO Node.JS API Web Interface. Visit Snyk Advisor to see a full health score report for wickrio_web_interface, including popularity, security, maintenance & community analysis.

Is wickrio_web_interface popular?

The npm package wickrio_web_interface receives a total of 6 weekly downloads. As such, wickrio_web_interface popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is wickrio_web_interface well maintained?

We found indications that wickrio_web_interface is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is wickrio_web_interface safe to use?

While scanning the latest version of wickrio_web_interface, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 7 November-2024, at 15:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

wickrio_web_interface

WickrIO Node.JS API Web Interface For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (6)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

WickrIO API Web Interface

Configuration:

Web Interface REST API

Usage:

wickrio_web_interface dependencies

FAQs

What is wickrio_web_interface?

Is wickrio_web_interface popular?

Is wickrio_web_interface well maintained?

Is wickrio_web_interface safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (6)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

WickrIO API Web Interface

Configuration:

Web Interface REST API

Usage:

wickrio_web_interface dependencies

FAQs

What is wickrio_web_interface?

Is wickrio_web_interface popular?

Is wickrio_web_interface well maintained?

Is wickrio_web_interface safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues