/usr/include/xsec/enc/NSS/NSSCryptoProvider.hpp is in libxml-security-c-dev 1.6.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* XSEC
*
* NSSCryptoProvider := Base class to handle NSS
*
* Author(s): Milan Tomic
*
*/
#ifndef NSSCRYPTOPROVIDER_INCLUDE
#define NSSCRYPTOPROVIDER_INCLUDE
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/enc/XSECCryptoProvider.hpp>
#if defined (XSEC_HAVE_NSS)
#include <pk11func.h>
#include <nss.h>
/**
* @defgroup nsscrypto NSS Interface
* @ingroup nsscrypto
* The NSS crypto provides an experimental inerface to the NSS API.
*/
/*\@{*/
class DSIG_EXPORT NSSCryptoProvider : public XSECCryptoProvider {
public :
/** @name Constructors and Destructors */
//@{
/**
* \brief Create a NSS interface layer
*
* @param dbDir Directory where NSS key database is stored.
* Will initialise NSS without DB support if nothing passed in.
* If you are writing Mozilla/Firefox plugin, you shouldn't
* use this ctor, because Mozilla/Firefox init NSS. Use empty
* ctor instead.
*/
NSSCryptoProvider(const char * dbDir);
/**
* \brief Create a NSS interface layer
*
* Will not initialise NSS library, user should do that
*/
NSSCryptoProvider();
virtual ~NSSCryptoProvider();
//@}
/** @name Hashing (Digest) Functions */
//@{
/**
* \brief Return a SHA1 implementation.
*
* Call used by the library to obtain a SHA1 object from the
* provider.
*
* @returns A pointer to an NSS Hash object that implements SHA1
* @see NSSCryptoHash
*/
virtual XSECCryptoHash * hashSHA1() const;
/**
* \brief Return a SHA1 implementation.
*
* Call used by the library to obtain a SHA1 object from the
* provider.
*
* @returns A pointer to an NSS Hash object that implements SHA1
* @see NSSCryptoHash
*/
virtual XSECCryptoHash * hashSHA(int length = 160) const;
/**
* \brief Return a HMAC SHA1 implementation.
*
* Call used by the library to obtain a HMAC SHA1 object from the
* provider. The caller will need to set the key in the hash
* object with an XSECCryptoKeyHMAC using NSSCryptoHash::setKey()
*
* @returns A pointer to a Hash object that implements HMAC-SHA1
* @see NSSCryptoHash
*/
virtual XSECCryptoHash * hashHMACSHA1() const;
/**
* \brief Return a HMAC SHA1 implementation.
*
* Call used by the library to obtain a HMAC SHA1 object from the
* provider. The caller will need to set the key in the hash
* object with an XSECCryptoKeyHMAC using NSSCryptoHash::setKey()
*
* @returns A pointer to a Hash object that implements HMAC-SHA1
* @see NSSCryptoHash
*/
virtual XSECCryptoHash * hashHMACSHA(int length = 160) const;
/**
* \brief Return a MD5 implementation.
*
* Call used by the library to obtain a MD5 object from the
* NSS provider.
*
* @returns A pointer to a Hash object that implements MD5
* @see NSSCryptoHash
*/
virtual XSECCryptoHash * hashMD5() const;
/**
* \brief Return a HMAC MD5 implementation.
*
* Call used by the library to obtain a HMAC MD5 object from the
* provider. The caller will need to set the key in the hash
* object with an XSECCryptoKeyHMAC using XSECCryptoHash::setKey()
*
* @note The use of MD5 is explicitly marked as <b>not recommended</b>
* in the XML Digital Signature standard due to recent advances in
* cryptography indicating there <em>may</em> be weaknesses in the
* algorithm.
*
* @returns A pointer to a Hash object that implements HMAC-MD5
* @see NSSCryptoHash
*/
virtual XSECCryptoHash * hashHMACMD5() const;
/**
* \brief Return a HMAC key
*
* Sometimes the library needs to create an HMAC key (notably within
* the XKMS utilities).
*
* This function allows the library to obtain a key that can then have
* a value set within it.
*/
virtual XSECCryptoKeyHMAC * keyHMAC(void) const;
/**
* \brief Determine whether a given algorithm is supported
*
* A call that can be used to determine whether a given
* digest algorithm is supported
*/
virtual bool algorithmSupported(XSECCryptoHash::HashType alg) const;
//@}
/** @name Encoding functions */
//@{
/**
* \brief Return a Base64 encoder/decoder implementation.
*
* Call used by the library to obtain a Base64
* encoder/decoder.
*
* @note NSS do implement Base64, but internal
* implementation (XSCrypt) is used instead.
*
* @returns Pointer to the new Base64 encoder.
* @see XSCryptCryptoBase64
*/
virtual XSECCryptoBase64 * base64() const;
//@}
/** @name Keys and Certificates */
//@{
/**
* \brief Return a DSA key implementation object.
*
* Call used by the library to obtain a DSA key object.
*
* @returns Pointer to the new DSA key
* @see NSSCryptoKeyDSA
*/
virtual XSECCryptoKeyDSA * keyDSA() const;
/**
* \brief Return an RSA key implementation object.
*
* Call used by the library to obtain an NSS RSA key object.
*
* @returns Pointer to the new RSA key
* @see NSSCryptoKeyRSA
*/
virtual XSECCryptoKeyRSA * keyRSA() const;
/**
* \brief Return an X509 implementation object.
*
* Call used by the library to obtain an object that can work
* with X509 certificates.
*
* @returns Pointer to the new X509 object
* @see NSSCryptoX509
*/
virtual XSECCryptoX509 * X509() const;
/**
* \brief Determine whether a given algorithm is supported
*
* A call that can be used to determine whether a given
* symmetric algorithm is supported
*/
virtual bool algorithmSupported(XSECCryptoSymmetricKey::SymmetricKeyType alg) const;
/**
* \brief Return a Symmetric Key implementation object.
*
* Call used by the library to obtain a bulk encryption
* object.
*
* @returns Pointer to the new SymmetricKey object
* @see XSECCryptoSymmetricKey
*/
virtual XSECCryptoSymmetricKey * keySymmetric(XSECCryptoSymmetricKey::SymmetricKeyType alg) const;
/**
* \brief Obtain some random octets
*
* For generation of IVs and the like, the library needs to be able
* to obtain "random" octets. The library uses this call to the
* crypto provider to obtain what it needs.
*
* @param buffer The buffer to place the random data in
* @param numOctets Number of bytes required
* @returns Number of bytes obtained.
*/
virtual unsigned int getRandom(unsigned char * buffer, unsigned int numOctets) const;
/**
* \brief Translate B64 I2OS integer to a NSS SECItem.
*
* Decodes a Base64 (ds:CryptoBinary) integer into SECItem.
*
* @param b64 Base 64 string
* @param b64Len Length of base64 string
* @param retLen Parameter to hold length of return integer
*/
static SECItem * b642SI(const char * b64, unsigned int b64Len);
/**
* \brief Translate a SECItem to a B64 I2OS integer .
*
* Encodes a SECItem in I2OSP base64 encoded format.
*
* @param n Buffer holding the SECItem
* @param nLen Length of data in buffer
* @param retLen Parameter to hold length of return integer
* @returns A pointer to a buffer holding the encoded data
* (transfers ownership)
*/
static unsigned char * SI2b64(SECItem * n, unsigned int &retLen);
//@}
/** @name Information Functions */
//@{
/**
* \brief Returns a string that identifies the Crypto Provider
*/
virtual const XMLCh * getProviderName() const;
//@}
private:
void Init(const char * dbDir);
static int m_initialised;
};
/*\@}*/
#endif /* XSEC_HAVE_NSS */
#endif /* NSSCRYPTOPROVIDER_INCLUDE */
|