crypto: crypto.create* - argument "options" is undocumented

Version: *
Platform: *
Subsystem: crypto

have a last optional argument options to control their stream behaviour

/cc @nodejs/documentation @nodejs/crypto @nodejs/streams

@refack

To clarify @refack, these options are the OpenSSL options?
These are strings, correct?

Edit: If so, will submit a PR with these changes.

AFAICT from looking at the code, they are also stream options, as these methods wrap the underlining OpenSSL mechanism with a node transform stream.
For example:

node/lib/crypto.js

Lines 75 to 81 in 0d22858

    
           exports.createHash = exports.Hash = Hash; 
        
           function Hash(algorithm, options) { 
        
             if (!(this instanceof Hash)) 
        
               return new Hash(algorithm, options); 
        
             this._handle = new binding.Hash(algorithm); 
        
             LazyTransform.call(this, options); 
        
           }

where LazyTransform is

node/lib/internal/streams/lazy_transform.js

Lines 12 to 17 in 0d22858

    
           function LazyTransform(options) { 
        
             this._options = options; 
        
             this.writable = true; 
        
             this.readable = true; 
        
           } 
        
           util.inherits(LazyTransform, stream.Transform);

@ashanhol

@ashanhol thanks for taking this on 🥇
There's an extra credit exercise to follow this up, but it requires some git spelunking, so it could wait for a future PR.

@refack

Thanks @refack for your comments, they really helped. It's sometimes difficult to determine types.
I updated the branch and will submit a PR. I'm definitely down for the extra credit.

Updated crypto docs to include options argument

@refack

@refack with the PR in works and waiting on the second round of approval, I'm available to jump into the next issue you had in mind.

doc: add options argument to crypto docs

Navigation Menu

Repository navigation

crypto: crypto.create* - argument "options" is undocumented #14804

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	exports.createHash = exports.Hash = Hash;
	function Hash(algorithm, options) {
	if (!(this instanceof Hash))
	return new Hash(algorithm, options);
	this._handle = new binding.Hash(algorithm);
	LazyTransform.call(this, options);
	}

	function LazyTransform(options) {
	this._options = options;
	this.writable = true;
	this.readable = true;
	}
	util.inherits(LazyTransform, stream.Transform);

crypto: crypto.create* - argument "options" is undocumented #14804

Description

Activity

ashanhol commented on Aug 15, 2017

refack commented on Aug 15, 2017

refack commented on Aug 15, 2017

ashanhol commented on Aug 16, 2017

ashanhol commented on Aug 16, 2017

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions