ossl_store-file(7ssl) [plan9 man page]

OSSL_STORE-FILE(7SSL)						      OpenSSL						     OSSL_STORE-FILE(7SSL)

NAME

       ossl_store-file - The store 'file' scheme loader

SYNOPSIS

       #include <openssl/store.h>

DESCRIPTION

       Support for the 'file' scheme is built into "libcrypto".  Since files come in all kinds of formats and content types, the 'file' scheme has
       its own layer of functionality called "file handlers", which are used to try to decode diverse types of file contents.

       In case a file is formatted as PEM, each called file handler receives the PEM name (everything following any '"-----BEGIN "') as well as
       possible PEM headers, together with the decoded PEM body.  Since PEM formatted files can contain more than one object, the file handlers
       are called upon for each such object.

       If the file isn't determined to be formatted as PEM, the content is loaded in raw form in its entirety and passed to the available file
       handlers as is, with no PEM name or headers.

       Each file handler is expected to handle PEM and non-PEM content as appropriate.	Some may refuse non-PEM content for the sake of
       determinism (for example, there are keys out in the wild that are represented as an ASN.1 OCTET STRING.	In raw form, it's not easily
       possible to distinguish those from any other data coming as an ASN.1 OCTET STRING, so such keys would naturally be accepted as PEM files
       only).

NOTES

       When needed, the 'file' scheme loader will require a pass phrase by using the "UI_METHOD" that was passed via OSSL_STORE_open().  This pass
       phrase is expected to be UTF-8 encoded, anything else will give an undefined result.  The files made accessible through this loader are
       expected to be standard compliant with regards to pass phrase encoding.	Files that aren't should be re-generated with a correctly encoded
       pass phrase.  See passphrase-encoding(7) for more information.

SEE ALSO

       ossl_store(7), passphrase-encoding(7)

COPYRIGHT

       Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.

       Licensed under the OpenSSL license (the "License").  You may not use this file except in compliance with the License.  You can obtain a
       copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

1.1.1a								    2018-12-18						     OSSL_STORE-FILE(7SSL)

OSSL_STORE(7SSL)						      OpenSSL							  OSSL_STORE(7SSL)

NAME

       ossl_store - Store retrieval functions

SYNOPSIS

       #include <openssl/store.h>

DESCRIPTION

   General
       A STORE is a layer of functionality to retrieve a number of supported objects from a repository of any kind, addressable as a file name or
       as a URI.

       The functionality supports the pattern "open a channel to the repository", "loop and retrieve one object at a time", and "finish up by
       closing the channel".

       The retrieved objects are returned as a wrapper type OSSL_STORE_INFO, from which an OpenSSL type can be retrieved.

   URI schemes and loaders
       Support for a URI scheme is called a STORE "loader", and can be added dynamically from the calling application or from a loadable engine.

       Support for the 'file' scheme is built into "libcrypto".  See ossl_store-file(7) for more information.

   UI_METHOD and pass phrases
       The OSS_STORE API does nothing to enforce any specific format or encoding on the pass phrase that the UI_METHOD provides.  However, the
       pass phrase is expected to be UTF-8 encoded.  The result of any other encoding is undefined.

EXAMPLES

   A generic call
	OSSL_STORE_CTX *ctx = OSSL_STORE_open("file:/foo/bar/data.pem");

	/*
	 * OSSL_STORE_eof() simulates file semantics for any repository to signal
	 * that no more data can be expected
	 */
	while (!OSSL_STORE_eof(ctx)) {
	    OSSL_STORE_INFO *info = OSSL_STORE_load(ctx);

	    /*
	     * Do whatever is necessary with the OSSL_STORE_INFO,
	     * here just one example
	     */
	    switch (OSSL_STORE_INFO_get_type(info)) {
	    case OSSL_STORE_INFO_X509:
		/* Print the X.509 certificate text */
		X509_print_fp(stdout, OSSL_STORE_INFO_get0_CERT(info));
		/* Print the X.509 certificate PEM output */
		PEM_write_X509(stdout, OSSL_STORE_INFO_get0_CERT(info));
		break;
	    }
	}

	OSSL_STORE_close(ctx);

SEE ALSO

       OSSL_STORE_INFO(3), OSSL_STORE_LOADER(3), OSSL_STORE_open(3), OSSL_STORE_expect(3), OSSL_STORE_SEARCH(3)

COPYRIGHT

       Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.

       Licensed under the OpenSSL license (the "License").  You may not use this file except in compliance with the License.  You can obtain a
       copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

1.1.1a								    2018-12-18							  OSSL_STORE(7SSL)