CDMSessionAVStreamSession.mm [plain text]
/*
* Copyright (C) 2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "config.h"
#import "CDMSessionAVStreamSession.h"
#if ENABLE(ENCRYPTED_MEDIA_V2) && ENABLE(MEDIA_SOURCE)
#import "AVFoundationSPI.h"
#import "CDM.h"
#import "CDMPrivateMediaSourceAVFObjC.h"
#import "ExceptionCode.h"
#import "FileSystem.h"
#import "Logging.h"
#import "MediaPlayer.h"
#import "SoftLinking.h"
#import "SourceBufferPrivateAVFObjC.h"
#import "UUID.h"
#import "WebCoreNSErrorExtras.h"
#import <AVFoundation/AVError.h>
#import <CoreMedia/CMBase.h>
#import <objc/objc-runtime.h>
#import <runtime/TypedArrayInlines.h>
#import <wtf/NeverDestroyed.h>
SOFT_LINK_FRAMEWORK_OPTIONAL(AVFoundation)
SOFT_LINK_CLASS(AVFoundation, AVStreamDataParser);
SOFT_LINK_CLASS_OPTIONAL(AVFoundation, AVStreamSession);
SOFT_LINK_CONSTANT_MAY_FAIL(AVFoundation, AVStreamDataParserContentKeyRequestProtocolVersionsKey, NSString *)
SOFT_LINK_CONSTANT_MAY_FAIL(AVFoundation, AVStreamSessionContentProtectionSessionIdentifierChangedNotification, NSString *)
@interface AVStreamSession : NSObject
- (void)addStreamDataParser:(AVStreamDataParser *)streamDataParser;
- (void)removeStreamDataParser:(AVStreamDataParser *)streamDataParser;
- (void)expire;
- (NSData *)contentProtectionSessionIdentifier;
+ (NSArray *)pendingExpiredSessionReportsWithAppIdentifier:(NSData *)appIdentifier storageDirectoryAtURL:(NSURL *)storageURL;
+ (void)removePendingExpiredSessionReports:(NSArray *)expiredSessionReports withAppIdentifier:(NSData *)appIdentifier storageDirectoryAtURL:(NSURL *)storageURL;
@end
@interface WebCDMSessionAVStreamSessionObserver : NSObject {
WebCore::CDMSessionAVStreamSession *m_parent;
}
@end
@implementation WebCDMSessionAVStreamSessionObserver
- (id)initWithParent:(WebCore::CDMSessionAVStreamSession *)parent
{
if ((self = [super init]))
m_parent = parent;
return self;
}
- (void)contentProtectionSessionIdentifierChanged:(NSNotification *)notification
{
AVStreamSession* streamSession = (AVStreamSession*)[notification object];
NSData* identifier = [streamSession contentProtectionSessionIdentifier];
RetainPtr<NSString> sessionIdentifierString = identifier ? adoptNS([[NSString alloc] initWithData:identifier encoding:NSUTF8StringEncoding]) : nil;
if (m_parent)
m_parent->setSessionId(sessionIdentifierString.get());
}
@end
static const NSString *PlaybackSessionIdKey = @"PlaybackSessionID";
namespace WebCore {
CDMSessionAVStreamSession::CDMSessionAVStreamSession(const Vector<int>& protocolVersions, CDMPrivateMediaSourceAVFObjC& cdm, CDMSessionClient* client)
: CDMSessionMediaSourceAVFObjC(cdm, client)
, m_weakPtrFactory(this)
, m_dataParserObserver(adoptNS([[WebCDMSessionAVStreamSessionObserver alloc] initWithParent:this]))
, m_protocolVersions(protocolVersions)
, m_mode(Normal)
{
}
CDMSessionAVStreamSession::~CDMSessionAVStreamSession()
{
setStreamSession(nullptr);
for (auto& sourceBuffer : m_sourceBuffers)
removeParser(sourceBuffer->parser());
}
RefPtr<Uint8Array> CDMSessionAVStreamSession::generateKeyRequest(const String& mimeType, Uint8Array* initData, String& destinationURL, unsigned short& errorCode, uint32_t& systemCode)
{
UNUSED_PARAM(mimeType);
UNUSED_PARAM(destinationURL);
ASSERT(initData);
LOG(Media, "CDMSessionAVStreamSession::generateKeyRequest(%p)", this);
errorCode = MediaPlayer::NoError;
systemCode = 0;
m_initData = initData;
if (equalLettersIgnoringASCIICase(mimeType, "keyrelease")) {
m_mode = KeyRelease;
return generateKeyReleaseMessage(errorCode, systemCode);
}
String certificateString(ASCIILiteral("certificate"));
RefPtr<Uint8Array> array = Uint8Array::create(certificateString.length());
for (unsigned i = 0, length = certificateString.length(); i < length; ++i)
array->set(i, certificateString[i]);
return array;
}
void CDMSessionAVStreamSession::releaseKeys()
{
if (m_streamSession) {
m_stopped = true;
for (auto& sourceBuffer : m_sourceBuffers)
sourceBuffer->flush();
LOG(Media, "CDMSessionAVStreamSession::releaseKeys(%p) - expiring stream session", this);
[m_streamSession expire];
if (!m_certificate)
return;
if (![getAVStreamSessionClass() respondsToSelector:@selector(pendingExpiredSessionReportsWithAppIdentifier:storageDirectoryAtURL:)])
return;
RetainPtr<NSData> certificateData = adoptNS([[NSData alloc] initWithBytes:m_certificate->data() length:m_certificate->length()]);
NSArray* expiredSessions = [getAVStreamSessionClass() pendingExpiredSessionReportsWithAppIdentifier:certificateData.get() storageDirectoryAtURL:[NSURL fileURLWithPath:storagePath()]];
for (NSData* expiredSessionData in expiredSessions) {
NSDictionary *expiredSession = [NSPropertyListSerialization propertyListWithData:expiredSessionData options:kCFPropertyListImmutable format:nullptr error:nullptr];
NSString *playbackSessionIdValue = (NSString *)[expiredSession objectForKey:PlaybackSessionIdKey];
if (![playbackSessionIdValue isKindOfClass:[NSString class]])
continue;
if (m_sessionId == String(playbackSessionIdValue)) {
LOG(Media, "CDMSessionAVStreamSession::releaseKeys(%p) - found session, sending expiration message");
m_expiredSession = expiredSessionData;
m_client->sendMessage(Uint8Array::create(static_cast<const uint8_t*>([m_expiredSession bytes]), [m_expiredSession length]).get(), emptyString());
break;
}
}
}
}
static bool isEqual(Uint8Array* data, const char* literal)
{
ASSERT(data);
ASSERT(literal);
unsigned length = data->length();
for (unsigned i = 0; i < length; ++i) {
if (!literal[i])
return false;
if (data->item(i) != static_cast<uint8_t>(literal[i]))
return false;
}
return !literal[length];
}
bool CDMSessionAVStreamSession::update(Uint8Array* key, RefPtr<Uint8Array>& nextMessage, unsigned short& errorCode, uint32_t& systemCode)
{
bool shouldGenerateKeyRequest = !m_certificate || isEqual(key, "renew");
if (!m_certificate) {
LOG(Media, "CDMSessionAVStreamSession::update(%p) - certificate data", this);
m_certificate = key;
}
if (isEqual(key, "acknowledged")) {
LOG(Media, "CDMSessionAVStreamSession::update(%p) - acknowleding secure stop message", this);
if (!m_expiredSession) {
errorCode = MediaPlayer::InvalidPlayerState;
return false;
}
RetainPtr<NSData> certificateData = adoptNS([[NSData alloc] initWithBytes:m_certificate->data() length:m_certificate->length()]);
if ([getAVStreamSessionClass() respondsToSelector:@selector(removePendingExpiredSessionReports:withAppIdentifier:storageDirectoryAtURL:)])
[getAVStreamSessionClass() removePendingExpiredSessionReports:@[m_expiredSession.get()] withAppIdentifier:certificateData.get() storageDirectoryAtURL:[NSURL fileURLWithPath:storagePath()]];
m_expiredSession = nullptr;
return true;
}
if (m_mode == KeyRelease)
return false;
RefPtr<SourceBufferPrivateAVFObjC> protectedSourceBuffer;
for (auto& sourceBuffer : m_sourceBuffers) {
if (sourceBuffer->protectedTrackID() != -1) {
protectedSourceBuffer = sourceBuffer;
break;
}
}
if (shouldGenerateKeyRequest) {
RetainPtr<NSData> certificateData = adoptNS([[NSData alloc] initWithBytes:m_certificate->data() length:m_certificate->length()]);
if (m_sourceBuffers.isEmpty())
return true;
if (!protectedSourceBuffer)
return true;
RetainPtr<NSData> initData = adoptNS([[NSData alloc] initWithBytes:m_initData->data() length:m_initData->length()]);
RetainPtr<NSDictionary> options;
if (!m_protocolVersions.isEmpty() && canLoadAVStreamDataParserContentKeyRequestProtocolVersionsKey()) {
RetainPtr<NSMutableArray> protocolVersionsOption = adoptNS([[NSMutableArray alloc] init]);
for (auto& version : m_protocolVersions) {
if (!version)
continue;
[protocolVersionsOption addObject:@(version)];
}
options = @{ getAVStreamDataParserContentKeyRequestProtocolVersionsKey(): protocolVersionsOption.get() };
}
NSError* error = nil;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
RetainPtr<NSData> request = [protectedSourceBuffer->parser() streamingContentKeyRequestDataForApp:certificateData.get() contentIdentifier:initData.get() trackID:protectedSourceBuffer->protectedTrackID() options:options.get() error:&error];
#pragma clang diagnostic pop
if (![protectedSourceBuffer->parser() respondsToSelector:@selector(contentProtectionSessionIdentifier)])
m_sessionId = createCanonicalUUIDString();
if (error) {
LOG(Media, "CDMSessionAVStreamSession::update(%p) - error:%@", this, [error description]);
errorCode = MediaPlayer::InvalidPlayerState;
systemCode = mediaKeyErrorSystemCode(error);
return false;
}
nextMessage = Uint8Array::create([request length]);
[request getBytes:nextMessage->data() length:nextMessage->length()];
return false;
}
ASSERT(!m_sourceBuffers.isEmpty());
LOG(Media, "CDMSessionAVStreamSession::update(%p) - key data", this);
errorCode = MediaPlayer::NoError;
systemCode = 0;
RetainPtr<NSData> keyData = adoptNS([[NSData alloc] initWithBytes:key->data() length:key->length()]);
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
[protectedSourceBuffer->parser() processContentKeyResponseData:keyData.get() forTrackID:protectedSourceBuffer->protectedTrackID()];
#pragma clang diagnostic pop
return true;
}
void CDMSessionAVStreamSession::setStreamSession(AVStreamSession *streamSession)
{
if (m_streamSession && canLoadAVStreamSessionContentProtectionSessionIdentifierChangedNotification())
[[NSNotificationCenter defaultCenter] removeObserver:m_dataParserObserver.get() name:getAVStreamSessionContentProtectionSessionIdentifierChangedNotification() object:m_streamSession.get()];
m_streamSession = streamSession;
if (!m_streamSession)
return;
if (canLoadAVStreamSessionContentProtectionSessionIdentifierChangedNotification())
[[NSNotificationCenter defaultCenter] addObserver:m_dataParserObserver.get() selector:@selector(contentProtectionSessionIdentifierChanged:) name:getAVStreamSessionContentProtectionSessionIdentifierChangedNotification() object:m_streamSession.get()];
NSData* identifier = [streamSession contentProtectionSessionIdentifier];
RetainPtr<NSString> sessionIdentifierString = identifier ? adoptNS([[NSString alloc] initWithData:identifier encoding:(NSUTF8StringEncoding)]) : nil;
setSessionId(sessionIdentifierString.get());
}
void CDMSessionAVStreamSession::addParser(AVStreamDataParser* parser)
{
if (m_streamSession)
[m_streamSession addStreamDataParser:parser];
}
void CDMSessionAVStreamSession::removeParser(AVStreamDataParser* parser)
{
if (m_streamSession)
[m_streamSession removeStreamDataParser:parser];
}
PassRefPtr<Uint8Array> CDMSessionAVStreamSession::generateKeyReleaseMessage(unsigned short& errorCode, uint32_t systemCode)
{
ASSERT(m_mode == KeyRelease);
m_certificate = m_initData;
RetainPtr<NSData> certificateData = adoptNS([[NSData alloc] initWithBytes:m_certificate->data() length:m_certificate->length()]);
if (![getAVStreamSessionClass() respondsToSelector:@selector(pendingExpiredSessionReportsWithAppIdentifier:storageDirectoryAtURL:)]) {
errorCode = MediaPlayer::KeySystemNotSupported;
systemCode = '!mor';
return nullptr;
}
NSArray* expiredSessions = [getAVStreamSessionClass() pendingExpiredSessionReportsWithAppIdentifier:certificateData.get() storageDirectoryAtURL:[NSURL fileURLWithPath:storagePath()]];
if (![expiredSessions count]) {
LOG(Media, "CDMSessionAVStreamSession::generateKeyReleaseMessage(%p) - no expired sessions found", this);
errorCode = MediaPlayer::KeySystemNotSupported;
systemCode = '!mor';
return nullptr;
}
LOG(Media, "CDMSessionAVStreamSession::generateKeyReleaseMessage(%p) - found %d expired sessions", this, [expiredSessions count]);
errorCode = 0;
systemCode = 0;
m_expiredSession = [expiredSessions firstObject];
return Uint8Array::create(static_cast<const uint8_t*>([m_expiredSession bytes]), [m_expiredSession length]);
}
}
#endif