RNIFReceiver Module

Properties   Methods   Events   Config Settings   Errors  

The RNIFReceiver module implements a RosettaNet server.

Syntax

IPWorksEDI.Rnifreceiver

Remarks

The RNIFReceiver implements server-side receiving of RosettaNet messages, as specified by the RosettaNet community. It can be used to decrypt and verify incoming messages and to generate synchronous receipts and replies if needed. The class is designed to be easily incorporated into an HTTP server. RosettaNet is used in a variety of industries including Semiconductor Manufacturing, Electronic Components, Telecommunications, Logistics, the Chemical Industry (through CIDX), and more.

BASIC OPERATION

When a RosettaNet request comes in, you should first call the ReadRequest method to read in the request. Once this is done, you must parse the headers and the request. You first parse the headers of the HTTP request using the ParseHeaders method. You may then set the appropriate certificates by setting the Certificate to your private key certificate and SignerCert to your trading partner's (signing) certificate.

The next step is to parse the RosettaNet message using ParseRequest. This method decrypts the message if needed. The class then parses all parts of the message. The preamble, delivery, and service headers are all parsed into the PreambleHeaderXML, DeliveryHeaderXML, and the ServiceHeaderXML, respectively. It also parses the actual body of the RosettaNet message, or the PIP, into the ServiceContent. Any attachments that may be in the message are parsed into the attachment array, and may be accessed via the Attachments property.

The class can also be used to handle synchronous responses. In order to complete this task, the receiver must first reset all header properties to values appropriate for a response. This may include changing values such as the MessageSenderId, MessageReceiverId, ActionCode, etc. The ServiceContent should then be set to a response indicating the state of the transaction. A typical response is a simple receipt acknowledgement, which has all qualities of a valid RosettaNet action, but is simply a receipt. Once these properties have been set, the message is ready to be sent using the SendResponse method.

NOTE: the RNIFReceiver Class can only handle sending synchronous responses. If an asynchronous response is desired, or required by a particular Partner Interface Process (PIP), you should use the RNIFSender class.

The following example illustrates how to use the class within a web page.

EXAMPLE

RNIFReceiver.ReadRequest(); RNIFReceiver.Certificate = new Certificate(CertStoreTypes.cstPFXFile, // Store type "\my_server_directory\encrypt.pfx", // File name "my password", // Password "CN=Encrypt"); // Subject RNIFReceiver.SignerCert = new Certificate("\my_server_directory\partnercert.cer"); RNIFReceiver.ParseHeaders(); RNIFReceiver.ParseRequest();

The server can then get the data from the preamble header, delivery header, service header, and the PIP content from their properties: PreambleHeaderXML, DeliveryHeaderXML, ServiceHeaderXML<;, and the ServiceContent, respectively. The message may then be easily processed, as all details of the transaction will be populated into their respective properties.

NOTE: Any attachments are saved by the name in the corresponding Attachments entry, and in the directory specified by the receiver. The directory is specified using the AttachmentOutputPath config property, and must be specified before you read and process the request. For example:

RNIFReceiver.Config("AttachmentOutputPath='\my_server_directory\Attachments'")

NOTE: In the above example, a receipt acknowledgement was not sent.

Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the RosettaNet response message. See the property and method list for details.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

ActionCode Property (RNIFReceiver Module)

The code for this action.

Syntax

• Swift
• Objective-C

public var actionCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=actionCode,setter=setActionCode:) NSString* actionCode;

- (NSString*)actionCode;
- (void)setActionCode :(NSString*)newActionCode;

Default Value

""

Remarks

This property is a string which denotes the type of action for the current RosettaNet message, if it is an action. If it is a reply, then the ActionCode describes the type of action that the message is in reply to. An example is a "Purchase Order Request Action."

This property is a field of the service header.

ActionMessage Property (RNIFReceiver Module)

Whether or not this message is an action message.

Syntax

• Swift
• Objective-C

public var actionMessage: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=actionMessage,setter=setActionMessage:) BOOL actionMessage;

- (BOOL)actionMessage;
- (void)setActionMessage :(BOOL)newActionMessage;

Default Value

False

Remarks

This property indicates whether or not the message is an action message. A RosettaNet action is defined as a message which requires or requests a business activity. A "PurchaseOrderRequestMessage" is a valid Business Action message, as is the corresponding "PurchaseOrderConfirmMessage". The latter, however, is also a reply to the original action request.

Receipt acknowledgments are considered Signals, and not Business Action messages, even though they contain all of the properties of a valid Business Action message.

This property is a field of the service header.

ActionMessageStandardName Property (RNIFReceiver Module)

The name of the standard used to create this action.

Syntax

• Swift
• Objective-C

public var actionMessageStandardName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=actionMessageStandardName,setter=setActionMessageStandardName:) NSString* actionMessageStandardName;

- (NSString*)actionMessageStandardName;
- (void)setActionMessageStandardName :(NSString*)newActionMessageStandardName;

Default Value

""

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in ActionMessageStandardName and the version in ActionMessageStandardVersion. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

ActionMessageStandardVersion Property (RNIFReceiver Module)

The version of the standard used to create this action.

Syntax

• Swift
• Objective-C

public var actionMessageStandardVersion: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=actionMessageStandardVersion,setter=setActionMessageStandardVersion:) NSString* actionMessageStandardVersion;

- (NSString*)actionMessageStandardVersion;
- (void)setActionMessageStandardVersion :(NSString*)newActionMessageStandardVersion;

Default Value

""

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in ActionMessageStandardName and the version in ActionMessageStandardVersion. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

Attachments Property (RNIFReceiver Module)

A collection of files attached to the current RNIF message.

Syntax

• Swift
• Objective-C

public var attachments: Array<RNIFAttachment> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=attachmentCount,setter=setAttachmentCount:) int attachmentCount;

- (int)attachmentCount;
- (void)setAttachmentCount :(int)newAttachmentCount;

- (NSString*)attachmentData:(int)attachmentIndex;
- (void)setAttachmentData:(int)attachmentIndex :(NSString*)newAttachmentData;

- (NSData*)attachmentDataB:(int)attachmentIndex;
- (void)setAttachmentDataB:(int)attachmentIndex :(NSData*)newAttachmentData;
- (NSString*)attachmentDescription:(int)attachmentIndex;
- (void)setAttachmentDescription:(int)attachmentIndex :(NSString*)newAttachmentDescription;

- (NSString*)attachmentFilename:(int)attachmentIndex;
- (void)setAttachmentFilename:(int)attachmentIndex :(NSString*)newAttachmentFilename;

- (NSString*)attachmentId:(int)attachmentIndex;
- (void)setAttachmentId:(int)attachmentIndex :(NSString*)newAttachmentId;

- (NSString*)attachmentMIMEType:(int)attachmentIndex;
- (void)setAttachmentMIMEType:(int)attachmentIndex :(NSString*)newAttachmentMIMEType;

 

Default Value

""

Remarks

This property describes the type of service that is being provided by the receiver of this message. This can be a short description of the service being provided, e.g. "Seller Service".

This property is a field of the service header.

BusinessActivity Property (RNIFReceiver Module)

This property denotes the type of business activity.

Syntax

• Swift
• Objective-C

public var businessActivity: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=businessActivity,setter=setBusinessActivity:) NSString* businessActivity;

- (NSString*)businessActivity;
- (void)setBusinessActivity :(NSString*)newBusinessActivity;

Default Value

""

Remarks

This property simply tells the receiver what type of business activity the RosettaNet document that is sent refers to. An example is: "Create Purchase Order".

CertEffectiveDate Property (RNIFReceiver Module)

This is the date on which this certificate becomes valid.

Syntax

• Swift
• Objective-C

public var certEffectiveDate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certEffectiveDate) NSString* certEffectiveDate;

- (NSString*)certEffectiveDate;

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

CertEncoded Property (RNIFReceiver Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var certEncoded: String {
  get {...}
  set {...}
}

public var certEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certEncoded,setter=setCertEncoded:) NSString* certEncoded;

- (NSString*)certEncoded;
- (void)setCertEncoded :(NSString*)newCertEncoded;

@property (nonatomic,readwrite,assign,getter=certEncodedB,setter=setCertEncodedB:) NSData* certEncodedB;

- (NSData*)certEncodedB;
- (void)setCertEncodedB :(NSData*)newCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setCertEncodedB(certEncoded: Data) throws
public func setCertEncoded(certEncoded: String) throws

CertExpirationDate Property (RNIFReceiver Module)

This is the date the certificate expires.

Syntax

• Swift
• Objective-C

public var certExpirationDate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certExpirationDate) NSString* certExpirationDate;

- (NSString*)certExpirationDate;

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

CertExtendedKeyUsage Property (RNIFReceiver Module)

This is a comma-delimited list of extended key usage identifiers.

Syntax

• Swift
• Objective-C

public var certExtendedKeyUsage: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certExtendedKeyUsage,setter=setCertExtendedKeyUsage:) NSString* certExtendedKeyUsage;

- (NSString*)certExtendedKeyUsage;
- (void)setCertExtendedKeyUsage :(NSString*)newCertExtendedKeyUsage;

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

CertFingerprint Property (RNIFReceiver Module)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

• Swift
• Objective-C

public var certFingerprint: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certFingerprint) NSString* certFingerprint;

- (NSString*)certFingerprint;

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

CertFingerprintSHA1 Property (RNIFReceiver Module)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

• Swift
• Objective-C

public var certFingerprintSHA1: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certFingerprintSHA1) NSString* certFingerprintSHA1;

- (NSString*)certFingerprintSHA1;

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

CertFingerprintSHA256 Property (RNIFReceiver Module)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

• Swift
• Objective-C

public var certFingerprintSHA256: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certFingerprintSHA256) NSString* certFingerprintSHA256;

- (NSString*)certFingerprintSHA256;

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

CertIssuer Property (RNIFReceiver Module)

This is the issuer of the certificate.

Syntax

• Swift
• Objective-C

public var certIssuer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certIssuer) NSString* certIssuer;

- (NSString*)certIssuer;

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

CertKeyPassword Property (RNIFReceiver Module)

This is the password for the certificate's private key (if any).

Syntax

• Swift
• Objective-C

public var certKeyPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certKeyPassword,setter=setCertKeyPassword:) NSString* certKeyPassword;

- (NSString*)certKeyPassword;
- (void)setCertKeyPassword :(NSString*)newCertKeyPassword;

Default Value

""

Remarks

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the CertStorePassword. CertKeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of CertStorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling CertPrivateKey.

CertPrivateKey Property (RNIFReceiver Module)

This is the private key of the certificate (if available).

Syntax

• Swift
• Objective-C

public var certPrivateKey: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certPrivateKey) NSString* certPrivateKey;

- (NSString*)certPrivateKey;

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

CertPrivateKeyAvailable Property (RNIFReceiver Module)

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

• Swift
• Objective-C

public var certPrivateKeyAvailable: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certPrivateKeyAvailable) BOOL certPrivateKeyAvailable;

- (BOOL)certPrivateKeyAvailable;

Default Value

False

Remarks

This property shows whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

CertPrivateKeyContainer Property (RNIFReceiver Module)

This is the name of the PrivateKey container for the certificate (if available).

Syntax

• Swift
• Objective-C

public var certPrivateKeyContainer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certPrivateKeyContainer) NSString* certPrivateKeyContainer;

- (NSString*)certPrivateKeyContainer;

Default Value

""

Remarks

This is the name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

CertPublicKey Property (RNIFReceiver Module)

This is the public key of the certificate.

Syntax

• Swift
• Objective-C

public var certPublicKey: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certPublicKey) NSString* certPublicKey;

- (NSString*)certPublicKey;

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

CertPublicKeyAlgorithm Property (RNIFReceiver Module)

This property contains the textual description of the certificate's public key algorithm.

Syntax

• Swift
• Objective-C

public var certPublicKeyAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certPublicKeyAlgorithm,setter=setCertPublicKeyAlgorithm:) NSString* certPublicKeyAlgorithm;

- (NSString*)certPublicKeyAlgorithm;
- (void)setCertPublicKeyAlgorithm :(NSString*)newCertPublicKeyAlgorithm;

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

CertPublicKeyLength Property (RNIFReceiver Module)

This is the length of the certificate's public key (in bits).

Syntax

• Swift
• Objective-C

public var certPublicKeyLength: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certPublicKeyLength) int certPublicKeyLength;

- (int)certPublicKeyLength;

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

CertSerialNumber Property (RNIFReceiver Module)

This is the serial number of the certificate encoded as a string.

Syntax

• Swift
• Objective-C

public var certSerialNumber: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certSerialNumber) NSString* certSerialNumber;

- (NSString*)certSerialNumber;

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

CertSignatureAlgorithm Property (RNIFReceiver Module)

The property contains the text description of the certificate's signature algorithm.

Syntax

• Swift
• Objective-C

public var certSignatureAlgorithm: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certSignatureAlgorithm) NSString* certSignatureAlgorithm;

- (NSString*)certSignatureAlgorithm;

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

CertStore Property (RNIFReceiver Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var certStore: String {
  get {...}
  set {...}
}

public var certStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certStore,setter=setCertStore:) NSString* certStore;

- (NSString*)certStore;
- (void)setCertStore :(NSString*)newCertStore;

@property (nonatomic,readwrite,assign,getter=certStoreB,setter=setCertStoreB:) NSData* certStoreB;

- (NSData*)certStoreB;
- (void)setCertStoreB :(NSData*)newCertStore;

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

CertStorePassword Property (RNIFReceiver Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• Swift
• Objective-C

public var certStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword;

- (NSString*)certStorePassword;
- (void)setCertStorePassword :(NSString*)newCertStorePassword;

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

CertStoreType Property (RNIFReceiver Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var certStoreType: RnifreceiverCertStoreTypes {
  get {...}
  set {...}
}

public enum RnifreceiverCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=certStoreType,setter=setCertStoreType:) int certStoreType;

- (int)certStoreType;
- (void)setCertStoreType :(int)newCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

CertSubject Property (RNIFReceiver Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var certSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certSubject,setter=setCertSubject:) NSString* certSubject;

- (NSString*)certSubject;
- (void)setCertSubject :(NSString*)newCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setCertSubject(certSubject: String) throws

CertSubjectAltNames Property (RNIFReceiver Module)

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

• Swift
• Objective-C

public var certSubjectAltNames: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certSubjectAltNames) NSString* certSubjectAltNames;

- (NSString*)certSubjectAltNames;

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

CertThumbprintMD5 Property (RNIFReceiver Module)

This property contains the MD5 hash of the certificate.

Syntax

• Swift
• Objective-C

public var certThumbprintMD5: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certThumbprintMD5) NSString* certThumbprintMD5;

- (NSString*)certThumbprintMD5;

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.

This property is read-only.

CertThumbprintSHA1 Property (RNIFReceiver Module)

This property contains the SHA-1 hash of the certificate.

Syntax

• Swift
• Objective-C

public var certThumbprintSHA1: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certThumbprintSHA1) NSString* certThumbprintSHA1;

- (NSString*)certThumbprintSHA1;

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.

This property is read-only.

CertThumbprintSHA256 Property (RNIFReceiver Module)

This property contains the SHA-256 hash of the certificate.

Syntax

• Swift
• Objective-C

public var certThumbprintSHA256: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=certThumbprintSHA256) NSString* certThumbprintSHA256;

- (NSString*)certThumbprintSHA256;

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.

This property is read-only.

CertUsage Property (RNIFReceiver Module)

This property contains the text description of UsageFlags .

Syntax

• Swift
• Objective-C

public var certUsage: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certUsage,setter=setCertUsage:) NSString* certUsage;

- (NSString*)certUsage;
- (void)setCertUsage :(NSString*)newCertUsage;

Default Value

""

Remarks

This property contains the text description of CertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signatures
• Key Authentication
• Key Encryption
• Data Encryption
• Key Agreement
• Certificate Signing
• Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

CertUsageFlags Property (RNIFReceiver Module)

This property contains the flags that show intended use for the certificate.

Syntax

• Swift
• Objective-C

public var certUsageFlags: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certUsageFlags,setter=setCertUsageFlags:) int certUsageFlags;

- (int)certUsageFlags;
- (void)setCertUsageFlags :(int)newCertUsageFlags;

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:

Please see the CertUsage property for a text representation of CertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

CertVersion Property (RNIFReceiver Module)