OSSL_STORE_EXPECT(3SSL)

📦
version 4.0.3 · 13 versions
, in ubuntu stonking

💖 OSSL_STORE_EXPECT 💖

okay bestie, gather round, because this is the OSSL_STORE_EXPECT(3SSL) page and it's literally about telling your loader what kind of object you're looking for before it goes rummaging around in your files. Three functions, one very specific job: specify what object type is expected. no cap. 🎀

✨ SYNOPSIS ✨

#include <openssl/store.h>

int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type);

int OSSL_STORE_supports_search(OSSL_STORE_CTX *ctx, int criterion_type);

int OSSL_STORE_find(OSSL_STORE_CTX *ctx, OSSL_STORE_SEARCH *search);

🦋 DESCRIPTION 🦋

OSSL_STORE_expect() is your little helper for filtering what OSSL_STORE_load() hands back to you — it does that by specifying a OSSL_STORE_INFO type. 💅

By default? literally no expectations on the types of objects to be loaded are made. anything goes, it's giving chaos. 🙈

expected_type can be 0 if you wanna say explicitly that you're making no expectation at all, or it can be any of the known object types (peep <hotpink>"SUPPORTED OBJECTS"</hotpink> in OSSL_STORE_INFO(3) for the full menu) — with one exception: not OSSL_STORE_INFO_NAME. sorry bestie, that one's off the table. 💀

ngl the example here is so clean: if "file:/foo/bar/store.pem" contains several objects of different type and only certificates are interesting, the application can simply say that it expects the type OSSL_STORE_INFO_CERT. icon behavior honestly. 🌸

OSSL_STORE_find() is the next level up — it helps applications specify a criterion for a more fine grained search of objects. so like, ✨picky✨ in the best way.

OSSL_STORE_supports_search() checks if the loader of the given OSSL_STORE context supports the given search type. want the tea on which search criterion types are a thing? go read <hotpink>"SUPPORTED CRITERION TYPES"</hotpink> in OSSL_STORE_SEARCH(3). iykyk. 🫶

🚨 TIMING CHECK, BESTIE 🚨 — OSSL_STORE_expect() and OSSL_STORE_find must be called before the first OSSL_STORE_load() of a given session, or they will fail. don't show up late to this party, fr fr. 😭

💜 NOTES 💜

If a more elaborate filter is required by the application, a better choice would be to use a post-processing function. (See OSSL_STORE_open(3) for more information. 💖)

However — and this is the slay part — some loaders may take advantage of the knowledge of an expected type to make object retrieval more efficient, so if a single type is expected, this method is usually preferable. 👑

⭐ RETURN VALUES ⭐

  • OSSL_STORE_expect() returns 1 on success, or 0 on failure.
  • OSSL_STORE_supports_search() returns 1 if the criterion is supported, or 0 otherwise.
  • OSSL_STORE_find() returns 1 on success, or 0 on failure.

🌈 SEE ALSO 🌈

🎀 HISTORY 🎀

OSSL_STORE_expect(), OSSL_STORE_supports_search() and OSSL_STORE_find() were added in OpenSSL 1.1.1. so they're not even new new, they've been serving looks for a minute. 💅

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

Licensed under the Apache License 2.0 (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>.

and that's the whole page bestie, no crumbs left 🍓 — this was OSSL_STORE_EXPECT(3SSL), OpenSSL 4.0.3, dated 2026-09-29. go filter some objects, you're gonna eat. 💖✨

📦 where this page comes from